Class PagedControl
Inheritance
Namespace: Manina.Windows.Forms
Assembly: PagedControl.dll
Syntax
[ToolboxBitmap(typeof(PagedControl))]
[Docking(DockingBehavior.Ask)]
public class PagedControl : Control, UnsafeNativeMethods.IOleControl, UnsafeNativeMethods.IOleObject, UnsafeNativeMethods.IOleInPlaceObject, UnsafeNativeMethods.IOleInPlaceActiveObject, UnsafeNativeMethods.IOleWindow, UnsafeNativeMethods.IViewObject, UnsafeNativeMethods.IViewObject2, UnsafeNativeMethods.IPersist, UnsafeNativeMethods.IPersistStreamInit, UnsafeNativeMethods.IPersistPropertyBag, UnsafeNativeMethods.IPersistStorage, UnsafeNativeMethods.IQuickActivate, ISupportOleDropSource, IDropTarget, ISynchronizeInvoke, IWin32Window, IArrangedElement, IBindableComponent, IComponent, IDisposable
Constructors
| Improve this Doc View SourcePagedControl()
Initializes a new instance of the PagedControl class.
Declaration
public PagedControl()
Properties
| Improve this Doc View SourceBorderStyle
Gets or sets the border style of the control.
Declaration
public BorderStyle BorderStyle { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Forms.BorderStyle |
CanGoBack
Determines whether the control can navigate to the previous page.
Declaration
[Browsable(false)]
public virtual bool CanGoBack { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
CanGoNext
Determines whether the control can navigate to the next page.
Declaration
[Browsable(false)]
public virtual bool CanGoNext { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
ClientRectangle
Gets the rectangle that represents the client area of the control.
Declaration
[Browsable(false)]
public Rectangle ClientRectangle { get; }
Property Value
Type | Description |
---|---|
System.Drawing.Rectangle |
DefaultSize
Gets the size of the control when it is initially created.
Declaration
protected override Size DefaultSize { get; }
Property Value
Type | Description |
---|---|
System.Drawing.Size |
Overrides
DisplayRectangle
Gets the client rectangle where pages are located.
Declaration
[Browsable(false)]
public override Rectangle DisplayRectangle { get; }
Property Value
Type | Description |
---|---|
System.Drawing.Rectangle |
Overrides
Pages
Gets or sets the collection of pages.
Declaration
public virtual PagedControl.PageCollection Pages { get; }
Property Value
Type | Description |
---|---|
PagedControl.PageCollection |
SelectedIndex
Gets or sets the zero-based index of the current page.
Declaration
public virtual int SelectedIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
SelectedPage
Gets or sets the current page.
Declaration
public virtual Page SelectedPage { get; set; }
Property Value
Type | Description |
---|---|
Page |
Methods
| Improve this Doc View SourceChangePage(Page, Boolean)
Changes the currently selected page to the given page.
Declaration
protected void ChangePage(Page page, bool allowModify = true)
Parameters
Type | Name | Description |
---|---|---|
Page | page | The page to make current. |
System.Boolean | allowModify | true to allow the page change to be cancelled and modifying the new page, otherwise false. |
CreateControlsInstance()
Declaration
protected override Control.ControlCollection CreateControlsInstance()
Returns
Type | Description |
---|---|
System.Windows.Forms.Control.ControlCollection |
Overrides
GoBack()
Navigates to the previous page.
Declaration
public void GoBack()
GoNext()
Navigates to the next page.
Declaration
public void GoNext()
OnCreateUIControls(CreateUIControlsEventArgs)
Raises the CreateUIControls event.
Declaration
protected virtual void OnCreateUIControls(CreateUIControlsEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
CreateUIControlsEventArgs | e | A CreateUIControlsEventArgs that contains event data. |
OnHandleCreated(EventArgs)
Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e |
Overrides
OnInvalidated(InvalidateEventArgs)
Declaration
protected override void OnInvalidated(InvalidateEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Forms.InvalidateEventArgs | e |
Overrides
OnPageAdded(PageEventArgs)
Raises the PageAdded event.
Declaration
protected virtual void OnPageAdded(PageEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
PageEventArgs | e | A PageEventArgs that contains event data. |
OnPageChanged(PageChangedEventArgs)
Raises the PageChanged event.
Declaration
protected virtual void OnPageChanged(PageChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
PageChangedEventArgs | e | A PageChangedEventArgs that contains event data. |
OnPageChanging(PageChangingEventArgs)
Raises the PageChanging event.
Declaration
protected virtual void OnPageChanging(PageChangingEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
PageChangingEventArgs | e | A PageChangingEventArgs that contains event data. |
OnPageHidden(PageEventArgs)
Raises the PageHidden event.
Declaration
protected virtual void OnPageHidden(PageEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
PageEventArgs | e | A PageEventArgs that contains event data. |
OnPagePaint(PagePaintEventArgs)
Raises the PagePaint event.
Declaration
protected virtual void OnPagePaint(PagePaintEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
PagePaintEventArgs | e | A PagePaintEventArgs that contains event data. |
OnPageRemoved(PageEventArgs)
Raises the PageRemoved event.
Declaration
protected virtual void OnPageRemoved(PageEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
PageEventArgs | e | A PageEventArgs that contains event data. |
OnPageShown(PageEventArgs)
Raises the PageShown event.
Declaration
protected virtual void OnPageShown(PageEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
PageEventArgs | e | A PageEventArgs that contains event data. |
OnPageValidated(PageEventArgs)
Raises the PageValidated event.
Declaration
protected virtual void OnPageValidated(PageEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
PageEventArgs | e | A PageEventArgs that contains event data. |
OnPageValidating(PageValidatingEventArgs)
Raises the PageValidating event.
Declaration
protected virtual void OnPageValidating(PageValidatingEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
PageValidatingEventArgs | e | A PageValidatingEventArgs that contains event data. |
OnPaint(PaintEventArgs)
Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Forms.PaintEventArgs | e |
Overrides
OnResize(EventArgs)
Declaration
protected override void OnResize(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e |
Overrides
OnUpdateUIControls(EventArgs)
Raises the UpdateUIControls event.
Declaration
protected virtual void OnUpdateUIControls(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e | An System.EventArgs that contains event data. |
UpdatePages()
Updates the display bounds and visibility of pages.
Declaration
protected void UpdatePages()
Events
| Improve this Doc View SourceCreateUIControls
Occurs when UI controls need to be created.
Declaration
public event EventHandler<CreateUIControlsEventArgs> CreateUIControls
Event Type
Type | Description |
---|---|
System.EventHandler<CreateUIControlsEventArgs> |
PageAdded
Occurs when a new page is added.
Declaration
public event EventHandler<PageEventArgs> PageAdded
Event Type
Type | Description |
---|---|
System.EventHandler<PageEventArgs> |
PageChanged
Occurs after the current page is changed.
Declaration
public event EventHandler<PageChangedEventArgs> PageChanged
Event Type
Type | Description |
---|---|
System.EventHandler<PageChangedEventArgs> |
PageChanging
Occurs before the current page is changed.
Declaration
public event EventHandler<PageChangingEventArgs> PageChanging
Event Type
Type | Description |
---|---|
System.EventHandler<PageChangingEventArgs> |
PageHidden
Occurs while the current page is changing and the previous current page is hidden.
Declaration
public event EventHandler<PageEventArgs> PageHidden
Event Type
Type | Description |
---|---|
System.EventHandler<PageEventArgs> |
PagePaint
Occurs when a page is painted.
Declaration
public event EventHandler<PagePaintEventArgs> PagePaint
Event Type
Type | Description |
---|---|
System.EventHandler<PagePaintEventArgs> |
PageRemoved
Occurs when a page is removed.
Declaration
public event EventHandler<PageEventArgs> PageRemoved
Event Type
Type | Description |
---|---|
System.EventHandler<PageEventArgs> |
PageShown
Occurs while the current page is changing and the new current page is shown.
Declaration
public event EventHandler<PageEventArgs> PageShown
Event Type
Type | Description |
---|---|
System.EventHandler<PageEventArgs> |
PageValidated
Occurs after the current page is successfully validated.
Declaration
public event EventHandler<PageEventArgs> PageValidated
Event Type
Type | Description |
---|---|
System.EventHandler<PageEventArgs> |
PageValidating
Occurs when the current page is validating.
Declaration
public event EventHandler<PageValidatingEventArgs> PageValidating
Event Type
Type | Description |
---|---|
System.EventHandler<PageValidatingEventArgs> |
UpdateUIControls
Occurs when UI controls need to be updated.
Declaration
public event EventHandler UpdateUIControls
Event Type
Type | Description |
---|---|
System.EventHandler |