Documentation

Class RadTaskDialogPage

A class that represents the content of RadTaskDialogForm

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadTaskDialogPage
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadTaskDialogPage : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider, IRadTaskDialogPage

Constructors

RadTaskDialogPage()

Initializes a new instance of the RadTaskDialogPage class.

Declaration
public RadTaskDialogPage()

Properties

AllowButtonsFocus

Gets or sets a value indicating whether the page buttons and radio buttons will have focused state.

Declaration
public bool AllowButtonsFocus { get; set; }
Property Value
System.Boolean

AllowCancel

Gets or sets a value indicating whether to show the close button of the RadTaskDialogForm

Declaration
public bool AllowCancel { get; set; }
Property Value
System.Boolean

AllowMinimize

Gets or sets a value indicating whether to show the minimize button of the RadTaskDialogForm

Declaration
public bool AllowMinimize { get; set; }
Property Value
System.Boolean

BottomLayout

Gets the bottom layout of the page, which holds the CommandArea, Footnote and the bottom description.

Declaration
public RadTaskDialogBottomLayout BottomLayout { get; }
Property Value
RadTaskDialogBottomLayout

BoundDialog

Gets the bounds RadTaskDialogForm

Declaration
public RadTaskDialogForm BoundDialog { get; }
Property Value
RadTaskDialogForm

Caption

Gets or sets the text of the RadTaskDialogForm when this page is shown in the dialog.

Declaration
public string Caption { get; set; }
Property Value
System.String

ClickedButton

Gets the clicked button of the page.

Declaration
public RadTaskDialogButton ClickedButton { get; }
Property Value
RadTaskDialogButton

CommandArea

Gets the command area, which holds the Expander, Verification and CommandAreaButtons.

Declaration
public RadTaskDialogCommandArea CommandArea { get; }
Property Value
RadTaskDialogCommandArea

CommandAreaButtons

Gets or sets the command button collection.

Declaration
public RadItemOwnerGenericCollection<RadTaskDialogButton> CommandAreaButtons { get; set; }
Property Value
RadItemOwnerGenericCollection<RadTaskDialogButton>

ContentArea

Gets the content area, which holds the page text, expander(description) text, progress bar, radio buttons and the command link buttons

Declaration
public RadTaskDialogContentArea ContentArea { get; }
Property Value
RadTaskDialogContentArea

ContentAreaButtons

Gets or sets the RadTaskDialogCommandLinkButton collection.

Declaration
public RadItemOwnerGenericCollection<RadTaskDialogCommandLinkButton> ContentAreaButtons { get; set; }
Property Value
RadItemOwnerGenericCollection<RadTaskDialogCommandLinkButton>

DefaultButton

Gets or sets the default buttons of the page, which has the initial focus when the page is shown.

Declaration
public RadTaskDialogButton DefaultButton { get; set; }
Property Value
RadTaskDialogButton

ElementsStack

Gets the vertical stack that holds the HeaderLayout and the BottomLayout

Declaration
public StackLayoutPanel ElementsStack { get; }
Property Value
StackLayoutPanel

Expander

Gets or sets the page expander.

Declaration
public RadTaskDialogExpander Expander { get; set; }
Property Value
RadTaskDialogExpander

Footnote

Gets or sets the footnote.

Declaration
public RadTaskDialogFootnote Footnote { get; set; }
Property Value
RadTaskDialogFootnote

HeaderLayout

Gets the header layout, which holds the Icon, header text element and the ContentArea

Declaration
public RadTaskDialogHeaderLayout HeaderLayout { get; }
Property Value
RadTaskDialogHeaderLayout

Heading

Gets or sets the heading text.

Declaration
public string Heading { get; set; }
Property Value
System.String

Icon

Gets or sets the icon.

Declaration
public RadTaskDialogIcon Icon { get; set; }
Property Value
RadTaskDialogIcon

ProgressBar

Gets or sets the page progress bar.

Declaration
public RadTaskDialogProgressBar ProgressBar { get; set; }
Property Value
RadTaskDialogProgressBar

RadioButtons

Gets or sets the RadTaskDialogRadioButton collection.

Declaration
public RadItemOwnerGenericCollection<RadTaskDialogRadioButton> RadioButtons { get; set; }
Property Value
RadItemOwnerGenericCollection<RadTaskDialogRadioButton>

RightToLeftLayout

Gets or sets a value indicating whether the page layout is right to left.

Declaration
public bool RightToLeftLayout { get; set; }
Property Value
System.Boolean

SizeToContent

Gets or sets a value indicating whether to use its default size or the size of the page(form) will be according to the content of the page.

Declaration
public bool SizeToContent { get; set; }
Property Value
System.Boolean

UseEqualHeaderAndIconHeight

Gets or sets a value indicating whether the header text and the icon will have equal heights. If [true] the Icon and HeaderTextElement will have equal height and the text and image will be aligned vertically. If [false] Icon and HeaderTextElement will have unique height, just to fit their content.

Declaration
public bool UseEqualHeaderAndIconHeight { get; set; }
Property Value
System.Boolean

UseWideContentArea

Gets or sets a value indicating, whether the content area will occupy the full width of the RadTaskDialogPage. If [false] the ContentArea will respect the width of the Icon. If [true] the ContentArea will occupy all the available width of the page.

Declaration
public bool UseWideContentArea { get; set; }
Property Value
System.Boolean

Verification

Gets or sets the page verification checkbox.

Declaration
public RadTaskDialogVerificationCheckBox Verification { get; set; }
Property Value
RadTaskDialogVerificationCheckBox

Methods

AddedToForm(RadForm)

Notifies the page, when it is added to a RadTaskDialogForm

Declaration
public void AddedToForm(RadForm form)
Parameters
RadForm form

The bound form.
Implements

CreateBottomLayout()

Declaration
protected virtual RadTaskDialogBottomLayout CreateBottomLayout()
Returns
RadTaskDialogBottomLayout

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateElementsStack()

Declaration
protected virtual StackLayoutPanel CreateElementsStack()
Returns
StackLayoutPanel

CreateHeaderLayout()

Declaration
protected virtual RadTaskDialogHeaderLayout CreateHeaderLayout()
Returns
RadTaskDialogHeaderLayout

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

Navigate(RadTaskDialogPage)

Navigates the RadTaskDialogForm to another page.

Declaration
public void Navigate(RadTaskDialogPage nextPage)
Parameters
RadTaskDialogPage nextPage

The next page to be displayed.

OnCreated(EventArgs)

Declaration
protected virtual void OnCreated(EventArgs e)
Parameters
System.EventArgs e

OnDestroyed(EventArgs)

Declaration
protected virtual void OnDestroyed(EventArgs e)
Parameters
System.EventArgs e

OnHelpRequest(EventArgs)

Declaration
protected virtual void OnHelpRequest(EventArgs e)
Parameters
System.EventArgs e

ProcessHelpRequested(HelpEventArgs)

Declaration
protected virtual bool ProcessHelpRequested(HelpEventArgs hevent)
Parameters
System.Windows.Forms.HelpEventArgs hevent

Returns
System.Boolean

ProcessKeyDown(PreviewKeyDownEventArgs)

Declaration
protected virtual bool ProcessKeyDown(PreviewKeyDownEventArgs e)
Parameters
System.Windows.Forms.PreviewKeyDownEventArgs e

Returns
System.Boolean

Events

Created

Raised after this RadTaskDialogPage is bound to a task dialog: after the dialog was created or navigated.

Declaration
public event EventHandler Created
Event Type
System.EventHandler

Destroyed

Raised when this RadTaskDialogPage is about to be unbound from a task dialog: when the dialog is about to be destroyed or about to navigate to another page.

Declaration
public event EventHandler Destroyed
Event Type
System.EventHandler

HelpRequest

Raised when the user presses F1 or clicks the "Help" standard button

Declaration
public event EventHandler HelpRequest
Event Type
System.EventHandler

Extension Methods