[]
        
(Showing Draft Content)

C1.Win.C1Win7Pack.C1TaskDialog

C1TaskDialog Class

A powerful successor to the MessageBox dialog window.

Inheritance
C1TaskDialog
Implements
Namespace: C1.Win.C1Win7Pack
Assembly: C1.Win.C1Win7Pack.4.8.dll
Syntax
[ToolboxBitmap(typeof(C1TaskDialog), "C1TaskDialog.png")]
public class C1TaskDialog : Component, IComponent, IDisposable

Constructors

Name Description
C1TaskDialog()

Initializes a new instance of a C1TaskDialog component.

C1TaskDialog(IContainer)

Initializes a new instance of a C1TaskDialog component.

Properties

Name Description
AllowCancel

Indicates that the dialog should be able to be closed using Alt-F4, Escape, and the title bar's close button.

CanBeMinimized

Gets or sets whether the task dialog can be minimized.

CheckBoxChecked

Gets or sets whether the verification check box is checked in the task dialog.

CheckBoxText

Gets or sets the string that is used to label the verification check box.

CheckedByDefault

Gets or sets whether the verification check box is checked by default.

ClickedCustomButton

Gets the button or the command link that was clicked in the task dialog and closed it.

CollapsedControlText

Gets or sets the string to be used to label the button for expanding the expandable information.

CommonButtons

Gets or sets the common push buttons displayed in the task dialog.

Content

Gets or sets the string to be used for the dialog's primary content.

CustomButtons

Gets the collection of custom buttons displayed in the task dialog.

DialogResult

Gets a value that was returned from the last call to the Show() method.

EnableCheckBox

Gets or sets whether the verification check box is enabled.

Enables hyperlink processing for the dialog strings.

EnableTimer

Gets or sets whether the TimerTick event is fired approximately every 200 milliseconds.

ExpandFooterArea

Indicates that the string specified by the ExpandedInformation property is displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content.

Expanded

Gets a value that indicates whether the expanded information is currently visible.

ExpandedByDefault

Indicates that the string specified by the ExpandedInformation property is visible when the dialog is initially displayed.

ExpandedControlText

Gets or sets the string to be used to label the button for collapsing the expandable information.

ExpandedInformation

Gets or sets the string to be used for displaying additional information.

FooterCommonIcon

Gets or sets the predefined icon to be displayed in the footer of the task dialog.

FooterCustomIcon

Gets or sets the custom Icon to be displayed in the footer area of the task dialog.

FooterText

Gets or sets the string displayed in the footer area of the task dialog.

IsPlatformSupported

Indicates whether the C1TaskDialog's capabilities are supported on the current platform.

MainCommonIcon

Gets or sets the predefined icon to be displayed in the task dialog.

MainCustomIcon

Gets or sets the custom Icon to be displayed in the task dialog.

MainInstruction

Gets or sets the string to be used for the main instruction.

Gets or sets whether the command links should appear without the default glyph. It doesn't affect whether or not the elevation icons should appear.

ProgressBar

Adjusts the progress bar control hosted in the task dialog.

RadioButtons

Gets the collection of radio buttons displayed in the task dialog.

RightToLeft

Gets or sets whether the task dialog should draw right-to-left for RTL languages.

SelectedRadioButton

Gets or sets a radio button that is currently selected in the task dialog.

SelectedRadioIndex

Gets or sets the zero-based index of a radio button that is currently selected.

SizeToContent

Gets or sets whether the width of the task dialog is determined by the width of its content area.

StartPosition

Gets or sets the initial position of the task dialog.

Tag

Gets or sets an object that contains additional data about the C1TaskDialog.

Indicates that the buttons specified in the CustomButtons collection should be displayed as command links.

Visible

Gets a value that indicates whether the task dialog is currently visible.

Width

The width of the task dialog's client area. If 0, the task dialog manager will calculate the ideal width.

WindowTitle

Gets or sets the string to be used for the task dialog title.

Methods

Name Description
BeginUpdate()

Maintains performance while multiple settings are being changed for a visible task dialog.

ClickButton(C1CustomButton)

Closes the task dialog by simulating a click on the specified C1CustomButton.

ClickButton(TaskDialogCommonButtons)

Closes the task dialog by simulating a click on the specified common button.

Close()

Closes the task dialog by simulating a click on the Cancel button.

Dispose(bool)

Clean up any resources being used.

EndUpdate()

Resumes processing after it has been suspended by a call to BeginUpdate().

OnButtonClick(TaskDialogButtonClickEventArgs)

Raises the ButtonClick event.

OnCheckBoxClick(EventArgs)

Raises the CheckBoxClick event.

OnExpandedChanged(EventArgs)

Raises the ExpandedChanged event.

OnHelpRequested(EventArgs)

Raises the HelpRequested event.

OnHyperlinkClick(TaskDialogHyperlinkClickEventArgs)

Raises the HyperlinkClick event.

OnInitialized(EventArgs)

Raises the Initialized event.

OnRadioButtonClick(EventArgs)

Raises the RadioButtonClick event.

OnRefreshed(EventArgs)

Raises the Refreshed event.

OnTimerTick(TaskDialogTimerTickEventArgs)

Raises the TimerTick event.

ResetFooterCustomIcon()
ResetMainCustomIcon()
SetDefaultButton(C1CustomButton)

Sets the default button for the task dialog.

SetDefaultButton(TaskDialogCommonButtons)

Sets the default button for the task dialog.

SetDefaultRadioButton(C1RadioButton)

Sets a radio button that will be selected by default.

SetDefaultRadioButton(C1RadioButton, bool)

Sets a radio button that will be selected by default.

SetDefaultRadioIndex(int)

Sets the index of a radio button that will be selected by default.

ShouldSerializeCustomButtons()
ShouldSerializeFooterCustomIcon()
ShouldSerializeMainCustomIcon()
ShouldSerializeProgressBar()
ShouldSerializeRadioButtons()
Show()

Creates and shows a task dialog with a default owner.

Show(bool)

Creates and shows a task dialog.

Show(IWin32Window)

Creates and shows a task dialog.

Events

Name Description
ButtonClick

Occurs when a button or a command link is clicked in the task dialog.

CheckBoxClick

Occurs after changing the state of the verification check box.

ExpandedChanged

Occurs when a user expands or collapses the task dialog.

HelpRequested

Occurs when the user presses F1 on the keyboard while the task dialog has focus.

HyperlinkClick

Occurs when a user clicks a hyperlink.

Initialized

Occurs before the task dialog is shown.

RadioButtonClick

Occurs after changing the selected radio button in the task dialog.

Refreshed

Occurs after the task dialog is fully refreshed.

TimerTick

Occurs approximately every 200 milliseconds (while the dialog is visible) if the EnableTimer property is set to True.