ClassRadTaskDialogPage
A class that represents the content of RadTaskDialogForm
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadTaskDialogPage : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IRadTaskDialogPage
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadTaskDialogPage
Implements:
Inherited Members
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.
AllowCancel
Gets or sets a value indicating whether to show the close button of the RadTaskDialogForm
AllowMinimize
Gets or sets a value indicating whether to show the minimize button of the RadTaskDialogForm
BottomLayout
Gets the bottom layout of the page, which holds the CommandArea, Footnote and the bottom description.
Declaration
public RadTaskDialogBottomLayout BottomLayout { get; }
Property Value
BoundDialog
Gets the bounds RadTaskDialogForm
Declaration
public RadTaskDialogForm BoundDialog { get; }
Property Value
Caption
Gets or sets the text of the RadTaskDialogForm when this page is shown in the dialog.
ClickedButton
Gets the clicked button of the page.
Declaration
public RadTaskDialogButton ClickedButton { get; }
Property Value
CommandArea
Gets the command area, which holds the Expander, Verification and CommandAreaButtons.
Declaration
public RadTaskDialogCommandArea CommandArea { get; }
Property Value
CommandAreaButtons
Gets or sets the command button collection.
Declaration
public RadItemOwnerGenericCollection<RadTaskDialogButton> CommandAreaButtons { get; set; }
Property Value
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
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
ElementsStack
Gets the vertical stack that holds the HeaderLayout and the BottomLayout
Declaration
public StackLayoutPanel ElementsStack { get; }
Property Value
Expander
Gets or sets the page expander.
Declaration
public RadTaskDialogExpander Expander { get; set; }
Property Value
Footnote
Gets or sets the footnote.
Declaration
public RadTaskDialogFootnote Footnote { get; set; }
Property Value
HeaderLayout
Gets the header layout, which holds the Icon, header text element and the ContentArea
Declaration
public RadTaskDialogHeaderLayout HeaderLayout { get; }
Property Value
Heading
Gets or sets the heading text.
Icon
Gets or sets the icon.
Declaration
public RadTaskDialogIcon Icon { get; set; }
Property Value
ProgressBar
Gets or sets the page progress bar.
Declaration
public RadTaskDialogProgressBar ProgressBar { get; set; }
Property Value
RadioButtons
Gets or sets the RadTaskDialogRadioButton collection.
Declaration
public RadItemOwnerGenericCollection<RadTaskDialogRadioButton> RadioButtons { get; set; }
Property Value
RightToLeftLayout
Gets or sets a value indicating whether the page layout is right to left.
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.
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
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.
Verification
Gets or sets the page verification checkbox.
Declaration
public RadTaskDialogVerificationCheckBox Verification { get; set; }
Property Value
Methods
AddedToForm(RadForm)
Notifies the page, when it is added to a RadTaskDialogForm
Declaration
public void AddedToForm(RadForm form)
Parameters
form
The bound form.
Implements
CreateBottomLayout()
Declaration
protected virtual RadTaskDialogBottomLayout CreateBottomLayout()
Returns
CreateChildElements()
Called by the element when constructed. Allows inheritors to build the element tree.
Declaration
protected override void CreateChildElements()
Overrides
CreateElementsStack()
Declaration
protected virtual StackLayoutPanel CreateElementsStack()
Returns
CreateHeaderLayout()
Declaration
protected virtual RadTaskDialogHeaderLayout CreateHeaderLayout()
Returns
InitializeFields()
Initializes the internal fields and components of the LightVisualElement. This method sets up text primitives, image primitives, and layout management components.
Declaration
protected override void InitializeFields()
Overrides
Navigate(RadTaskDialogPage)
Navigates the RadTaskDialogForm to another page.
Declaration
public void Navigate(RadTaskDialogPage nextPage)
Parameters
nextPage
The next page to be displayed.
OnDestroyed(EventArgs)
Declaration
protected virtual void OnDestroyed(EventArgs e)
Parameters
e
OnHelpRequest(EventArgs)
Declaration
protected virtual void OnHelpRequest(EventArgs e)
Parameters
e
ProcessHelpRequested(HelpEventArgs)
Declaration
protected virtual bool ProcessHelpRequested(HelpEventArgs hevent)
Parameters
hevent
Returns
ProcessKeyDown(PreviewKeyDownEventArgs)
Declaration
protected virtual bool ProcessKeyDown(PreviewKeyDownEventArgs e)
Parameters
e
Returns
Events
Created
Raised after this RadTaskDialogPage is bound to a task dialog: after the dialog was created or navigated.
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.
HelpRequest
Raised when the user presses F1 or clicks the "Help" standard button