Class XPTaskPane

The XPTaskPane is a WordXP like control that you can see on the right when you start Microsoft Word XP. It is a wizard based class. You can easily Add/Remove pages using the designer verbs in the designer or by calling the AddPage/RemovePage methods of the base class.

Inheritance
System.Object
Wizard
XPTaskPane
Implements
System.ComponentModel.ISupportInitialize
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class XPTaskPane : Wizard, ISupportInitialize, INonClientPaintingSupport, IVisualStyle

Constructors

XPTaskPane()

Declaration
public XPTaskPane()

Properties

BackColor

Gets or sets the backcolor. (overridden property)

Declaration
public override Color BackColor { get; set; }
Property Value
Type Description
System.Drawing.Color

DownScroll

Gets the vertical down scroll bar.

Declaration
public VerticalScrollBar DownScroll { get; }
Property Value
Type Description
VerticalScrollBar

EnableTouchMode

Gets or sets value to enable or disable the Touchmode to the controls.

Declaration
public bool EnableTouchMode { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Scale factor will be updated automatically if scalefactor is equal to 1

Header

Gets the Header Panel.

Declaration
public XPTaskPaneHeader Header { get; }
Property Value
Type Description
XPTaskPaneHeader

HeaderLabel

Gets the Header Title-Label.

Declaration
public XPTaskPaneHeaderLabel HeaderLabel { get; }
Property Value
Type Description
XPTaskPaneHeaderLabel

HeaderLeftToolbar

Gets the Header's left XPToolBar control.

Declaration
public XPToolBar HeaderLeftToolbar { get; }
Property Value
Type Description
XPToolBar

HeaderMenuItem

Gets the Header's dropdown menu (ParentBarItem).

Declaration
public ParentBarItem HeaderMenuItem { get; }
Property Value
Type Description
ParentBarItem

HeaderRightToolbar

Gets the Header's right XPToolBar control.

Declaration
public XPToolBar HeaderRightToolbar { get; }
Property Value
Type Description
XPToolBar

MetroColor

Declaration
public Color MetroColor { get; set; }
Property Value
Type Description
System.Drawing.Color

Office2007ColorScheme

Gets or sets office 2007 color scheme for the control.

Declaration
public Office2007Theme Office2007ColorScheme { get; set; }
Property Value
Type Description
Office2007Theme

Office2010ColorScheme

Gets or sets office 2010 color scheme for the control.

Declaration
public Office2010Theme Office2010ColorScheme { get; set; }
Property Value
Type Description
Office2010Theme

ScrollSpeed

Gets or sets the scrolling speed of Vertical Scroll.

Declaration
public int ScrollSpeed { get; set; }
Property Value
Type Description
System.Int32

TaskPages

Gets or sets the array that holds pages.

Declaration
public virtual XPTaskPage[] TaskPages { get; set; }
Property Value
Type Description
XPTaskPage[]

TaskPanePageContainer

Gets or sets the PageContainer of the XPTaskPane.

Declaration
public WizardContainer TaskPanePageContainer { get; set; }
Property Value
Type Description
WizardContainer

UpScroll

Declaration
public VerticalScrollBar UpScroll { get; }
Property Value
Type Description
VerticalScrollBar

VerticalScroll

Gets or sets a value indicating whether enables scroll buttons that occupy vertical space instead of horizontal space instead of default scrollbar.

Declaration
public bool VerticalScroll { get; set; }
Property Value
Type Description
System.Boolean

VisualStyle

Gets or sets the style to be used for drawing the XPTaskPane control.

Declaration
public VisualStyle VisualStyle { get; set; }
Property Value
Type Description
VisualStyle

WizardPages

Gets or sets the wizard pages.

Declaration
public override WizardPage[] WizardPages { get; set; }
Property Value
Type Description
WizardPage[]
Overrides

Methods

ApplyScaleToControl(Single)

Scale the control based on the scale factor passed in the argument.

Declaration
public void ApplyScaleToControl(float scaleFactor)
Parameters
Type Name Description
System.Single scaleFactor

value to scale the factor based upon.

DesignerClick(Point)

Called by the designer when the user clicks on the next or back buttons.

Declaration
public bool DesignerClick(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt

Point for hit point
Returns
Type Description
System.Boolean

Returns true if designer click

Dispose(Boolean)

Cleans up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Bool disposing
Overrides

GetOffice2007PathFromBounds(Rectangle)

Gets rounded borders for drawing control in Office2007 style.

Declaration
public GraphicsPath GetOffice2007PathFromBounds(Rectangle bounds)
Parameters
Type Name Description
System.Drawing.Rectangle bounds

Bounds of the control ot get path from.
Returns
Type Description
System.Drawing.Drawing2D.GraphicsPath

Returns Graphics path

OnDockChanged(EventArgs)

Declaration
protected override void OnDockChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnEndInit()

Called by the Designer when the control is first created.

Declaration
protected override void OnEndInit()
Overrides

OnFontChanged(EventArgs)

Declaration
protected override void OnFontChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnRightToLeftChanged(EventArgs)

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnSizeChanged(EventArgs)

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

PageSettingsChanged()

Declaration
protected override void PageSettingsChanged()
Overrides

RefreshAppearance()

Declaration
protected override void RefreshAppearance()
Overrides

ResetBackColor()

Resets the BackColor property to its default value.

Declaration
public override void ResetBackColor()

SetPageContainer(WizardContainer)

Declaration
public override void SetPageContainer(WizardContainer container)
Parameters
Type Name Description
WizardContainer container
Overrides

ShouldSerializeDownScroll()

Declaration
public bool ShouldSerializeDownScroll()
Returns
Type Description
System.Boolean

ShouldSerializeHeader()

Declaration
public bool ShouldSerializeHeader()
Returns
Type Description
System.Boolean

ShouldSerializeHeaderLabel()

Declaration
public bool ShouldSerializeHeaderLabel()
Returns
Type Description
System.Boolean

ShouldSerializeUpScroll()

Declaration
public bool ShouldSerializeUpScroll()
Returns
Type Description
System.Boolean

UpdateDockRelatedProperties()

Declaration
protected void UpdateDockRelatedProperties()

UpdateDockRelatedProperties(Boolean)

Declaration
protected void UpdateDockRelatedProperties(bool bIsMirrored)
Parameters
Type Name Description
System.Boolean bIsMirrored

UpdateRTLRelatedProperties()

Declaration
protected void UpdateRTLRelatedProperties()

UpdateRTLRelatedProperties(Boolean)

Declaration
protected void UpdateRTLRelatedProperties(bool bIsMirrored)
Parameters
Type Name Description
System.Boolean bIsMirrored

UpdateToolBarItemsImageDrawing(XPToolBar, Boolean)

Declaration
protected void UpdateToolBarItemsImageDrawing(XPToolBar xptbToolBar, bool bIsMirrored)
Parameters
Type Name Description
XPToolBar xptbToolBar
System.Boolean bIsMirrored

WndProc(ref Message)

Declaration
protected override void WndProc(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m

Explicit Interface Implementations

INonClientPaintingSupport.NonClientPaint(PaintEventArgs, Rectangle, Rectangle)

Declaration
IntPtr INonClientPaintingSupport.NonClientPaint(PaintEventArgs e, Rectangle displayRect, Rectangle windowRectInScreen)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e
System.Drawing.Rectangle displayRect
System.Drawing.Rectangle windowRectInScreen
Returns
Type Description
System.IntPtr

IVisualStyle.VisualTheme

Declaration
string IVisualStyle.VisualTheme { get; set; }
Returns
Type Description
System.String

Implements

System.ComponentModel.ISupportInitialize