1398 lines
66 KiB
XML
1398 lines
66 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Bunifu.UI.WinForms.BunifuFormDock</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Bunifu.UI.WinForms.BunifuFormDock">
|
|
<summary>
|
|
Provides enhanced and customizable form-docking capabilities to borderless Windows Forms.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.#ctor">
|
|
<summary>
|
|
Creates a new Bunifu Form Dock component.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.BunifuFormDock.BunifuWindowStates">
|
|
<summary>
|
|
Provides a general list of window-states available
|
|
for use in borderless Forms displayed on-screen.
|
|
This mimics the standard <see cref="T:System.Windows.Forms.FormWindowState"/>
|
|
enumeration but has been tailored for handling borderless forms.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.BunifuWindowStates.Normal">
|
|
<summary>
|
|
A normal window.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.BunifuWindowStates.Maximized">
|
|
<summary>
|
|
A maximized window.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.BunifuWindowStates.Minimized">
|
|
<summary>
|
|
A minimized window.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.BunifuFormDock.FormWindowStates">
|
|
<summary>
|
|
Provides a general list of window-states available
|
|
for use in borderless Forms displayed on-screen.
|
|
This mimics the standard <see cref="T:System.Windows.Forms.FormWindowState"/>
|
|
enumeration but has been tailored for handling borderless forms.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.FormWindowStates.Normal">
|
|
<summary>
|
|
A normal window.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.FormWindowStates.Maximized">
|
|
<summary>
|
|
A maximized window.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.FormWindowStates.Minimized">
|
|
<summary>
|
|
A minimized window.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.BunifuFormDock.DockIndicators">
|
|
<summary>
|
|
Provides a list of available docking indicators
|
|
visible when dragging forms on-screen.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockIndicators.None">
|
|
<summary>
|
|
No indicator is shown.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockIndicators.Left">
|
|
<summary>
|
|
The left dock indicator.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockIndicators.Right">
|
|
<summary>
|
|
The right dock indicator.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockIndicators.TopLeft">
|
|
<summary>
|
|
The top-left dock indicator.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockIndicators.TopRight">
|
|
<summary>
|
|
The top-right dock indicator.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockIndicators.FullScreen">
|
|
<summary>
|
|
The full-screen dock indicator.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockIndicators.BottomLeft">
|
|
<summary>
|
|
The bottom-left dock indicator.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockIndicators.BottomRight">
|
|
<summary>
|
|
The bottom-right dock indicator.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.BunifuFormDock.DockPositions">
|
|
<summary>
|
|
Provides a list of supported form-docking positions.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockPositions.None">
|
|
<summary>
|
|
No dock position applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockPositions.Left">
|
|
<summary>
|
|
The left dock position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockPositions.Right">
|
|
<summary>
|
|
The right dock position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockPositions.TopLeft">
|
|
<summary>
|
|
Tge top-left dock position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockPositions.TopRight">
|
|
<summary>
|
|
The top-right dock position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockPositions.FullScreen">
|
|
<summary>
|
|
The full-screen dock position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockPositions.BottomLeft">
|
|
<summary>
|
|
The bottom-left dock position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.DockPositions.BottomRight">
|
|
<summary>
|
|
The bottom-right dock position.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.AllowHidingBottomRegion">
|
|
<summary>
|
|
When set to true, a white region that is drawn
|
|
at the bottom of the parent form will be hidden;
|
|
however, when set to false, this region will be
|
|
exposed at runtime.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.BorderOptions">
|
|
<summary>
|
|
Gets or sets Form border options that can be
|
|
used to add and style borders on the parent form.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.DockingOptions">
|
|
<summary>
|
|
Gets or sets the docking options to be used in the parent form.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.TitleBarOptions">
|
|
<summary>
|
|
Gets or sets the list of options for selecting and managing
|
|
any control that is set as the parent form's Title Bar.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.AllowDockingKeys">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form will allow
|
|
the standard Windows docking keys to be supported at runtime.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.AllowFormDragging">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form will be draggable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.AllowFormDropShadow">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form will have a drop-shadow along its borders..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.AllowFormResizing">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form will be resizable when borderless.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.AllowOpacityChangesWhileDragging">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form's opacity or transparency
|
|
will be changed whenever it's being dragged on screen.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.ShowCursorChanges">
|
|
<summary>
|
|
Gets or sets a value indicating whether cursor-changes
|
|
will be provided when about to dock the parent form.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.ShowDockingIndicators">
|
|
<summary>
|
|
Gets or sets a value indicating whether the docking indicators
|
|
will be previewed before the parent form is docked.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.DockingIndicatorsColor">
|
|
<summary>
|
|
Gets or sets the color of the docking indicators.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.DockingIndicatorsOpacity">
|
|
<summary>
|
|
Gets or sets the opacity or transparency of the docking indicators.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.FormDraggingOpacity">
|
|
<summary>
|
|
Gets or sets the opacity or transparency of the parent form when dragging.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.WindowState">
|
|
<summary>
|
|
Gets or sets the window-state for the form.
|
|
This mimics the standard <see cref="T:System.Windows.Forms.FormWindowState"/> enumeration
|
|
but has been tailored for handling borderless forms.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.BunifuWindowState">
|
|
<summary>
|
|
Gets or sets the window-state for the form.
|
|
This mimics the standard <see cref="T:System.Windows.Forms.FormWindowState"/> enumeration
|
|
but has been tailored for handling borderless forms.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.ContainerControl">
|
|
<summary>
|
|
Gets or sets the container control within the parent form.
|
|
In most cases, this refers and results to the parent form.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.ParentForm">
|
|
<summary>
|
|
Gets or sets the container control as the parent form.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.Site">
|
|
<summary>
|
|
Overrides the ISite functionality, getting the main or parent
|
|
container control in the Form. This is overriden to get the
|
|
component's host or parent form.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.ApplyShadows">
|
|
<summary>
|
|
Applies a surrounding shadow to the target form.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.AddBottomSeparator(System.Drawing.Color,System.Int32,System.Boolean)">
|
|
<summary>
|
|
Adds a bottom Line Separator to the attached Parent Form.
|
|
</summary>
|
|
<param name="color">Sets the background color of the Separator.</param>
|
|
<param name="height">Sets the height of the Separator.</param>
|
|
<param name="dockSeparator">
|
|
Allow docking the Separator to the bottom area? (Disabled by default)
|
|
If allowed, the Separator will be docked to the bottom-most area
|
|
of the Parent Form; else, it will be anchored to the bottom-most area.
|
|
Both options however perform the same way at runtime.
|
|
</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.SubscribeControlToDragEvents(System.Windows.Forms.Control,System.Boolean)">
|
|
<summary>
|
|
Subscribes any control specified to the drag
|
|
event operations performed on the parent form.
|
|
</summary>
|
|
<param name="control">
|
|
The control to be subscribed to the drag events.
|
|
</param>
|
|
<param name="isPartOfTitleBar">
|
|
If the control is a part of the Title Bar section, set this parameter
|
|
to true in order for the control to be subscribed to the
|
|
<see cref="P:Bunifu.UI.WinForms.TitleBarOptions.DoubleClickToExpandWindow"/> setting.
|
|
</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.SubscribeControlsToDragEvents(System.Windows.Forms.Control[],System.Boolean)">
|
|
<summary>
|
|
Subscribes an array of controls specified to the drag
|
|
event operations performed on the parent form.
|
|
</summary>
|
|
<param name="controls">
|
|
An array of controls to be subscribed to the drag events.
|
|
</param>
|
|
<param name="arePartOfTitleBar">
|
|
If the controls are part of the Title Bar section, set this parameter
|
|
to true in order for the controls to be subscribed to the
|
|
<see cref="P:Bunifu.UI.WinForms.TitleBarOptions.DoubleClickToExpandWindow"/> setting.
|
|
</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.UnsubscribeControlToDragEvents(System.Windows.Forms.Control,System.Boolean)">
|
|
<summary>
|
|
Unsubscribes any control attached to the drag
|
|
event operations performed on the parent form.
|
|
</summary>
|
|
<param name="control">
|
|
The control previously attached to the drag events.
|
|
</param>
|
|
<param name="wasPartOfTitleBar">
|
|
If the control was a part of the Title Bar section, set this parameter
|
|
to true in order for the control to be unsubscribed to the
|
|
<see cref="P:Bunifu.UI.WinForms.TitleBarOptions.DoubleClickToExpandWindow"/> setting.
|
|
</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.UnsubscribeControlsToDragEvents(System.Windows.Forms.Control[],System.Boolean)">
|
|
<summary>
|
|
Unsubscribes an array of controls attached to the drag
|
|
event operations performed on the parent form.
|
|
</summary>
|
|
<param name="controls">
|
|
An array of controls previously attached to the drag events.
|
|
</param>
|
|
<param name="werePartOfTitleBar">
|
|
If the controls were part of the Title Bar section, set this parameter
|
|
to true in order for the controls to be unsubscribed to the
|
|
<see cref="P:Bunifu.UI.WinForms.TitleBarOptions.DoubleClickToExpandWindow"/> setting.
|
|
</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.ParentFormIsNormal">
|
|
<summary>
|
|
Checks if the parent form is in the normal state.
|
|
</summary>
|
|
<returns><see cref="!:true"/> or <see cref="!:false"/></returns>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockedLeft">
|
|
<summary>
|
|
Checks if the parent form is docked to the left.
|
|
</summary>
|
|
<returns><see cref="!:true"/> or <see cref="!:false"/></returns>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockedTopLeft">
|
|
<summary>
|
|
Checks if the parent form is docked to the top-left.
|
|
</summary>
|
|
<returns><see cref="!:true"/> or <see cref="!:false"/></returns>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockedBottomLeft">
|
|
<summary>
|
|
Checks if the parent form is docked to the bottom-left.
|
|
</summary>
|
|
<returns><see cref="!:true"/> or <see cref="!:false"/></returns>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockedRight">
|
|
<summary>
|
|
Checks if the parent form is docked to the right.
|
|
</summary>
|
|
<returns><see cref="!:true"/> or <see cref="!:false"/></returns>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockedTopRight">
|
|
<summary>
|
|
Checks if the parent form is docked to the ltop-right.
|
|
</summary>
|
|
<returns><see cref="!:true"/> or <see cref="!:false"/></returns>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockedBottomRight">
|
|
<summary>
|
|
Checks if the parent form is docked to the bottom-right.
|
|
</summary>
|
|
<returns><see cref="!:true"/> or <see cref="!:false"/></returns>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.ExpandWindow">
|
|
<summary>
|
|
Expands the parent form to fit the current screen dimensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockLeft">
|
|
<summary>
|
|
Docks the parent form to the left area of the screen.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockTopLeft">
|
|
<summary>
|
|
Docks the parent form to the top-left corner of the screen.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockBottomLeft">
|
|
<summary>
|
|
Docks the parent form to the bottom-left corner of the screen.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockRight">
|
|
<summary>
|
|
Docks the parent form to the right area of the screen.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockTopRight">
|
|
<summary>
|
|
Docks the parent form to the top-right corner of the screen.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockBottomRight">
|
|
<summary>
|
|
Docks the parent form to the bottom-right corner of the screen.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.IndicateFullScreenDocking">
|
|
<summary>
|
|
Indicates that the parent form is about to be docked to full-screen mode.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.IndicateLeftDocking">
|
|
<summary>
|
|
Indicates that the parent form is about to be docked to the left screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.IndicateTopLeftDocking">
|
|
<summary>
|
|
Indicates that the parent form is about to be docked to the top-left screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.IndicateBottomLeftDocking">
|
|
<summary>
|
|
Indicates that the parent form is about to be docked to the bottom-left screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.IndicateRightDocking">
|
|
<summary>
|
|
Indicates that the parent form is about to be docked to the right screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.IndicateTopRightDocking">
|
|
<summary>
|
|
Indicates that the parent form is about to be docked to the top-right screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.IndicateBottomRightDocking">
|
|
<summary>
|
|
Indicates that the parent form is about to be docked to the bottom-right screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.IndicateNormalPositioning">
|
|
<summary>
|
|
Indicates that the parent form is about to be reverted to
|
|
its normal or original dimensions as per its size and location.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.HideDockingIndicators">
|
|
<summary>
|
|
Hides any visual cues that may have been displayed when
|
|
docking the parent form.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.ShowDockingAreaIndicators">
|
|
<summary>
|
|
Displays any visual cues based on the area the parent form
|
|
is about to be docked to.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.AddFormBorders(System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Adds borders to the parent form.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.CreateBitmap(System.Drawing.Color,System.Drawing.Size)">
|
|
<summary>
|
|
Creates a colored Bitmap Image.
|
|
</summary>
|
|
<param name="color">The <see cref="T:System.Drawing.Color"/> to be applied.</param>
|
|
<param name="size">The <see cref="T:System.Drawing.Size"/> of the Bitmap.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.IsInDesignMode">
|
|
<summary>
|
|
Determines whether the hosting process is in design-mode.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.ProvideFirstTimeOptionsGuide">
|
|
<summary>
|
|
This method takes the user through a quick set of first-time options
|
|
available to use in order to guide them on the component's usage.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Bunifu.UI.WinForms.BunifuFormDock.FormDragging">
|
|
<summary>
|
|
Occurs whenever the parent form is being dragged.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Bunifu.UI.WinForms.BunifuFormDock.DockChanged">
|
|
<summary>
|
|
Occurs whenever the <see cref="P:Bunifu.UI.WinForms.BunifuFormDock.DockingOptions"/> property has been changed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.BunifuFormDock.FormDraggingEventArgs">
|
|
<summary>
|
|
Provides data for the <see cref="E:Bunifu.UI.WinForms.BunifuFormDock.FormDragging"/> event.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.FormDraggingEventArgs.#ctor(System.Drawing.Point,Bunifu.UI.WinForms.BunifuFormDock.DockIndicators)">
|
|
<summary>
|
|
Provides data for the <see cref="E:Bunifu.UI.WinForms.BunifuFormDock.FormDragging"/> event.
|
|
</summary>
|
|
<param name="cursorPosition">The position of the cursor on the screen.</param>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.FormDraggingEventArgs.CursorPosition">
|
|
<summary>
|
|
Gets the current position of the cursor.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.FormDraggingEventArgs.ShownIndicator">
|
|
<summary>
|
|
Gets the indicator that is currently being shown
|
|
as the parent form is being dragged.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.BunifuFormDock.DockChangedEventArgs">
|
|
<summary>
|
|
Provides data for the <see cref="E:Bunifu.UI.WinForms.BunifuFormDock.DockChanged"/> event.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.DockChangedEventArgs.#ctor(Bunifu.UI.WinForms.BunifuFormDock.DockPositions)">
|
|
<summary>
|
|
Provides data for the <see cref="E:Bunifu.UI.WinForms.BunifuFormDock.DockChanged"/> event.
|
|
</summary>
|
|
<param name="dockPosition">The currently docked position of the parent form.</param>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuFormDock.DockChangedEventArgs.DockPosition">
|
|
<summary>
|
|
Gets the docked position the parent form is on.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.OnMouseUp(System.Object,System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Raises the component's "MouseUp" event.
|
|
Use this to attach any control's "MouseUp" event to this "OnMouseUp" event.
|
|
</summary>
|
|
<param name="sender">The sender control.</param>
|
|
<param name="e">Provides data for the control's "MouseUp" event. </param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.OnMouseMove(System.Object,System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Raises the component's "MouseMove" event.
|
|
Use this to attach any control's "MouseMove" event to this "OnMouseMove" event.
|
|
</summary>
|
|
<param name="sender">The sender control.</param>
|
|
<param name="e">Provides data for the control's "MouseMove" event. </param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.OnMouseDown(System.Object,System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Raises the component's "MouseDown" event.
|
|
Use this to attach any control's "MouseDown" event to this "OnMouseDown" event.
|
|
</summary>
|
|
<param name="sender">The sender control.</param>
|
|
<param name="e">Provides data for the control's "MouseDown" event. </param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.OnDoubleClickTitleBar(System.Object,System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Raises the attached Title Bar's "MouseDoubleClick" event.
|
|
</summary>
|
|
Use this to attach any control's "MouseDoubleClick" event to this "MouseDoubleClick" event.
|
|
<param name="sender">The sender control.</param>
|
|
<param name="e">Provides data for the control's "MouseDoubleClick" event. </param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.OnLoad(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Raises the parent form's "OnLoad" event.
|
|
</summary>
|
|
<param name="sender">The sender control.</param>
|
|
<param name="e">Provides data for the parent form's "OnLoad" event. </param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.OnResizeEnd(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Raises the parent form's "OnResizeEnd" event.
|
|
</summary>
|
|
<param name="sender">The sender control.</param>
|
|
<param name="e">Provides data for the parent form's "OnResizeEnd" event. </param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.OnKeyDown(System.Object,System.Windows.Forms.KeyEventArgs)">
|
|
<summary>
|
|
Raises the component's "KeyDown" event.
|
|
</summary>
|
|
<param name="sender">The sender control.</param>
|
|
<param name="e">Provides data for the control's "KeyDown" event. </param>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.BunifuFormDock.BunifuComponentActionList">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Bunifu.UI.WinForms.BunifuFormDock.BunifuComponentActionList"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.BunifuComponentActionList.GetSortedActionItems">
|
|
<summary>
|
|
Implementation of this abstract method creates Smart Tag items,
|
|
associates their targets, and collects them into a list.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuFormDock.components">
|
|
<summary>
|
|
Required designer variable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.Dispose(System.Boolean)">
|
|
<summary>
|
|
Clean up any resources being used.
|
|
</summary>
|
|
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuFormDock.InitializeComponent">
|
|
<summary>
|
|
Required method for Designer support - do not modify
|
|
the contents of this method with the code editor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.WindowHandler">
|
|
<summary>
|
|
Attaches, accesses and extends any Windows Form specified outside its own class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.WindowHandler.#ctor(System.Windows.Forms.Form,System.Boolean)">
|
|
<summary>
|
|
Creates a window handle to any specified Windows Form.
|
|
</summary>
|
|
<param name="parent">The parent form to handle.</param>
|
|
<param name="allowResizing">Allow the parent form to resize?</param>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.WindowHandler.BunifuFormDock">
|
|
<summary>
|
|
Gets or sets the Bunifu Form Dock instance to be accessed and used.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.DockOptions">
|
|
<summary>
|
|
Provides a list of supported docking options in Windows Forms.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.DockOptions.#ctor">
|
|
<summary>
|
|
Creates a new Docking Options class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.DockOptions.DockAll">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form can be docked to all supported screen areas.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.DockOptions.DockLeft">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form can be docked to the left screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.DockOptions.DockRight">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form can be docked to the right screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.DockOptions.DockFullScreen">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form can be docked to fill the screen's dimensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.DockOptions.DockTopLeft">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form can be docked to the top-left screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.DockOptions.DockTopRight">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form can be docked to the top-right screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.DockOptions.DockBottomLeft">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form can be docked to the bottom-left screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.DockOptions.DockBottomRight">
|
|
<summary>
|
|
Gets or sets a value indicating whether the parent form can be docked to the bottom-right screen area.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.DockOptions.ToString">
|
|
<summary>
|
|
Returns a <see cref="T:System.String"/> containing the list of docking options
|
|
provided and their applied statuses separated by semi-colons.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.TitleBarOptions">
|
|
<summary>
|
|
Provides a list of options for selecting and managing any
|
|
control that is to be used as the parent form's Title Bar.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.TitleBarOptions.#ctor">
|
|
<summary>
|
|
Creates a new Title Bar Options class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.TitleBarOptions.BunifuFormDock">
|
|
<summary>
|
|
Gets or sets the Bunifu Form Dock instance to be accessed and used.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.TitleBarOptions.TitleBarControl">
|
|
<summary>
|
|
Gets or sets the control to be used as the parent form's Title Bar.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.TitleBarOptions.DoubleClickToExpandWindow">
|
|
<summary>
|
|
Gets or sets a value indicating whether the Title Bar control
|
|
will expand the parent form once a user double-clicks on it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.TitleBarOptions.UseBackColorOnDockingIndicators">
|
|
<summary>
|
|
Gets or sets a value indicating whether the docking indicators
|
|
will inherit the Title Bar's background color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.TitleBarOptions.AllowFormDragging">
|
|
<summary>
|
|
Gets or sets a value indicating whether the Title Bar control
|
|
will be allowed to drag the parent form at runtime.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.TitleBarOptions.ToString">
|
|
<summary>
|
|
Returns a <see cref="T:System.String"/> containing the list of Title Bar options
|
|
provided and their applied property values separated by semi-colons.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.FormBorderOptions">
|
|
<summary>
|
|
Provides a list of options for customizing
|
|
a borderless Form's border regions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.FormBorderOptions.#ctor">
|
|
<summary>
|
|
Creates a new Form Border Options class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.FormBorderOptions.ToString">
|
|
<summary>
|
|
Returns a <see cref="T:System.String"/> containing the list of Form Border Options
|
|
provided and their applied property values separated by semi-colons.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.FormBorderOptions.BorderRegion">
|
|
<summary>
|
|
Provides a list of options for customizing
|
|
a borderless Form's single border region.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.FormBorderOptions.BorderRegion.ToString">
|
|
<summary>
|
|
Returns a <see cref="T:System.String"/> containing the list of Form Border Options
|
|
provided and their applied property values separated by semi-colons.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.IManagedType">
|
|
<summary>
|
|
Interface for all types we can perform transitions on.
|
|
Each type (e.g. int, double, Color) that we can perform a transition on
|
|
needs to have its own class that implements this interface. These classes
|
|
tell the transition system how to act on objects of that type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.IManagedType.getManagedType">
|
|
<summary>
|
|
Returns the Type that the instance is managing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.IManagedType.copy(System.Object)">
|
|
<summary>
|
|
Returns a deep copy of the object passed in. (In particular this is
|
|
needed for types that are objects.)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.IManagedType.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Returns an object holding the value between the start and end corresponding
|
|
to the percentage passed in. (Note: the percentage can be less than 0% or
|
|
greater than 100%.)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ITransitionType.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
Called by the Transition framework when its timer ticks to pass in the
|
|
time (in ms) since the transition started.
|
|
|
|
You should return (in an out parameter) the percentage movement towards
|
|
the destination value for the time passed in. Note: this does not need to
|
|
be a smooth transition from 0% to 100%. You can overshoot with values
|
|
greater than 100% or undershoot if you need to (for example, to have some
|
|
form of "elasticity").
|
|
|
|
The percentage should be returned as (for example) 0.1 for 10%.
|
|
|
|
You should return (in an out parameter) whether the transition has completed.
|
|
(This may not be at the same time as the percentage has moved to 100%.)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.ManagedType_Color">
|
|
<summary>
|
|
Class that manages transitions for Color properties. For these we
|
|
need to transition the R, G, B and A sub-properties independently.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Color.getManagedType">
|
|
<summary>
|
|
Returns the type we are managing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Color.copy(System.Object)">
|
|
<summary>
|
|
Returns a copy of the color object passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Color.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Creates an intermediate value for the colors depending on the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.ManagedType_Double">
|
|
<summary>
|
|
Manages transitions for double properties.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Double.getManagedType">
|
|
<summary>
|
|
Returns the type managed by this class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Double.copy(System.Object)">
|
|
<summary>
|
|
Returns a copy of the double passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Double.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Returns the value between start and end for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Float.getManagedType">
|
|
<summary>
|
|
Returns the type we're managing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Float.copy(System.Object)">
|
|
<summary>
|
|
Returns a copy of the float passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Float.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Returns the interpolated value for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.ManagedType_Int">
|
|
<summary>
|
|
Manages transitions for int properties.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Int.getManagedType">
|
|
<summary>
|
|
Returns the type we are managing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Int.copy(System.Object)">
|
|
<summary>
|
|
Returns a copy of the int passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_Int.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Returns the value between the start and end for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.ManagedType_String">
|
|
<summary>
|
|
Manages transitions for strings. This doesn't make as much sense as transitions
|
|
on other types, but I like the way it looks!
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_String.getManagedType">
|
|
<summary>
|
|
Returns the type we're managing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_String.copy(System.Object)">
|
|
<summary>
|
|
Returns a copy of the string passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.ManagedType_String.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Returns an "interpolated" string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.Transition">
|
|
<summary>
|
|
Lets you perform animated transitions of properties on arbitrary objects. These
|
|
will often be transitions of UI properties, for example an animated fade-in of
|
|
a UI object, or an animated move of a UI object from one position to another.
|
|
|
|
Each transition can simulataneously change multiple properties, including properties
|
|
across multiple objects.
|
|
|
|
Example transition
|
|
------------------
|
|
a. Transition t = new Transition(new TransitionMethod_Linear(500));
|
|
b. t.add(form1, "Width", 500);
|
|
c. t.add(form1, "BackColor", Color.Red);
|
|
d. t.run();
|
|
|
|
Line a: Creates a new transition. You specify the transition method.
|
|
|
|
Lines b. and c: Set the destination values of the properties you are animating.
|
|
|
|
Line d: Starts the transition.
|
|
|
|
Transition methods
|
|
------------------
|
|
TransitionMethod objects specify how the transition is made. Examples include
|
|
linear transition, ease-in-ease-out and so on. Different transition methods may
|
|
need different parameters.
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.#cctor">
|
|
<summary>
|
|
You should register all managed-types here.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.Transition.Args">
|
|
<summary>
|
|
Args passed with the TransitionCompletedEvent.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Utilities.BunifuFormDock.Transitions.Transition.TransitionCompletedEvent">
|
|
<summary>
|
|
Event raised when the transition hass completed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.run(System.Object,System.String,System.Object,Utilities.BunifuFormDock.Transitions.ITransitionType)">
|
|
<summary>
|
|
Creates and immediately runs a transition on the property passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.run(System.Object,System.String,System.Object,System.Object,Utilities.BunifuFormDock.Transitions.ITransitionType)">
|
|
<summary>
|
|
Sets the property passed in to the initial value passed in, then creates and
|
|
immediately runs a transition on it.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.runChain(Utilities.BunifuFormDock.Transitions.Transition[])">
|
|
<summary>
|
|
Creates a TransitionChain and runs it.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.#ctor(Utilities.BunifuFormDock.Transitions.ITransitionType)">
|
|
<summary>
|
|
Constructor. You pass in the object that holds the properties
|
|
that you are performing transitions on.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.add(System.Object,System.String,System.Object)">
|
|
<summary>
|
|
Adds a property that should be animated as part of this transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.run">
|
|
<summary>
|
|
Starts the transition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuFormDock.Transitions.Transition.TransitionedProperties">
|
|
<summary>
|
|
Property that returns a list of information about each property managed
|
|
by this transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.removeProperty(Utilities.BunifuFormDock.Transitions.Transition.TransitionedPropertyInfo)">
|
|
<summary>
|
|
We remove the property with the info passed in from the transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.onTimer">
|
|
<summary>
|
|
Called when the transition timer ticks.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.setProperty(System.Object,Utilities.BunifuFormDock.Transitions.Transition.PropertyUpdateArgs)">
|
|
<summary>
|
|
Sets a property on the object passed in to the value passed in. This method
|
|
invokes itself on the GUI thread if the property is being invoked on a GUI
|
|
object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.isDisposed(System.Object)">
|
|
<summary>
|
|
Returns true if the object passed in is a Control and is disposed
|
|
or in the process of disposing. (If this is the case, we don't want
|
|
to make any changes to its properties.)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Transition.registerType(Utilities.BunifuFormDock.Transitions.IManagedType)">
|
|
<summary>
|
|
Registers a transition-type. We hold them in a map.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionChain.runNextTransition">
|
|
<summary>
|
|
Runs the next transition in the list.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionChain.onTransitionCompleted(System.Object,Utilities.BunifuFormDock.Transitions.Transition.Args)">
|
|
<summary>
|
|
Called when the transition we have just run has completed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionElement.#ctor(System.Double,System.Double,Utilities.BunifuFormDock.Transitions.InterpolationMethod)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuFormDock.Transitions.TransitionElement.EndTime">
|
|
<summary>
|
|
The percentage of elapsed time, expressed as (for example) 75 for 75%.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuFormDock.Transitions.TransitionElement.EndValue">
|
|
<summary>
|
|
The value of the animated properties at the EndTime. This is the percentage
|
|
movement of the properties between their start and end values. This should
|
|
be expressed as (for example) 75 for 75%.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuFormDock.Transitions.TransitionElement.InterpolationMethod">
|
|
<summary>
|
|
The interpolation method to use when moving between the previous value
|
|
and the current one.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.TransitionManager">
|
|
<summary>
|
|
This class is responsible for running transitions. It holds the timer that
|
|
triggers transaction animation.
|
|
</summary><remarks>
|
|
This class is a singleton.
|
|
|
|
We manage the transaction timer here so that we can have a single timer
|
|
across all transactions. If each transaction has its own timer, this creates
|
|
one thread for each transaction, and this can lead to too many threads in
|
|
an application.
|
|
|
|
This class essentially just manages the timer for the transitions. It calls
|
|
back into the running transitions, which do the actual work of the transition.
|
|
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionManager.getInstance">
|
|
<summary>
|
|
Singleton's getInstance method.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionManager.register(Utilities.BunifuFormDock.Transitions.Transition)">
|
|
<summary>
|
|
You register a transition with the manager here. This will start to run
|
|
the transition as the manager's timer ticks.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionManager.removeDuplicates(Utilities.BunifuFormDock.Transitions.Transition)">
|
|
<summary>
|
|
Checks if any existing transitions are acting on the same properties as the
|
|
transition passed in. If so, we remove the duplicated properties from the
|
|
older transitions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionManager.removeDuplicates(Utilities.BunifuFormDock.Transitions.Transition,Utilities.BunifuFormDock.Transitions.Transition)">
|
|
<summary>
|
|
Finds any properties in the old-transition that are also in the new one,
|
|
and removes them from the old one.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionManager.#ctor">
|
|
<summary>
|
|
Private constructor (for singleton).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionManager.onTimerElapsed(System.Object,System.Timers.ElapsedEventArgs)">
|
|
<summary>
|
|
Called when the timer ticks.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionManager.onTransitionCompleted(System.Object,Utilities.BunifuFormDock.Transitions.Transition.Args)">
|
|
<summary>
|
|
Called when a transition has completed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.TransitionType_Acceleration">
|
|
<summary>
|
|
Manages transitions under constant acceleration from a standing start.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_Acceleration.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the time that the transition
|
|
will take (in milliseconds).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_Acceleration.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
Works out the percentage completed given the time passed in.
|
|
This uses the formula:
|
|
s = ut + 1/2at^2
|
|
The initial velocity is 0, and the acceleration to get to 1.0
|
|
at t=1.0 is 2, so the formula just becomes:
|
|
s = t^2
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.TransitionType_Bounce">
|
|
<summary>
|
|
This transition bounces the property to a destination value and back to the
|
|
original value. It is accelerated to the destination and then decelerated back
|
|
as if being dropped with gravity and bouncing back against gravity.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_Bounce.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the total time taken for the bounce.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.TransitionType_CriticalDamping">
|
|
<summary>
|
|
This transition animates with an exponential decay. This has a damping effect
|
|
similar to the motion of a needle on an electomagnetically controlled dial.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_CriticalDamping.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the time that the transition
|
|
will take (in milliseconds).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_CriticalDamping.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.TransitionType_Deceleration">
|
|
<summary>
|
|
Manages a transition starting from a high speed and decelerating to zero by
|
|
the end of the transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_Deceleration.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the time that the transition
|
|
will take (in milliseconds).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_Deceleration.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
Works out the percentage completed given the time passed in.
|
|
This uses the formula:
|
|
s = ut + 1/2at^2
|
|
The initial velocity is 2, and the acceleration to get to 1.0
|
|
at t=1.0 is -2, so the formula becomes:
|
|
s = t(2-t)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.TransitionType_EaseInEaseOut">
|
|
<summary>
|
|
Manages an ease-in-ease-out transition. This accelerates during the first
|
|
half of the transition, and then decelerates during the second half.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_EaseInEaseOut.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the time that the transition
|
|
will take (in milliseconds).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_EaseInEaseOut.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
Works out the percentage completed given the time passed in.
|
|
This uses the formula:
|
|
s = ut + 1/2at^2
|
|
We accelerate as at the rate needed (a=4) to get to 0.5 at t=0.5, and
|
|
then decelerate at the same rate to end up at 1.0 at t=1.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.TransitionType_Flash">
|
|
<summary>
|
|
This transition type 'flashes' the properties a specified number of times, ending
|
|
up by reverting them to their initial values. You specify the number of bounces and
|
|
the length of each bounce.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_Flash.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
You specify the number of bounces and the time taken for each bounce.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.TransitionType_Linear">
|
|
<summary>
|
|
This class manages a linear transition. The percentage complete for the transition
|
|
increases linearly with time.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_Linear.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the time (in milliseconds) that the
|
|
transition will take.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_Linear.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
We return the percentage completed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.TransitionType_ThrowAndCatch">
|
|
<summary>
|
|
This transition bounces the property to a destination value and back to the
|
|
original value. It is decelerated to the destination and then acclerated back
|
|
as if being thrown against gravity and then descending back with gravity.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_ThrowAndCatch.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the total time taken for the bounce.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.TransitionType_UserDefined">
|
|
<summary>
|
|
This class allows you to create user-defined transition types. You specify these
|
|
as a list of TransitionElements. Each of these defines:
|
|
End time , End value, Interpolation method
|
|
|
|
For example, say you want to make a bouncing effect with a decay:
|
|
|
|
EndTime% EndValue% Interpolation
|
|
-------- --------- -------------
|
|
50 100 Acceleration
|
|
75 50 Deceleration
|
|
85 100 Acceleration
|
|
91 75 Deceleration
|
|
95 100 Acceleration
|
|
98 90 Deceleration
|
|
100 100 Acceleration
|
|
|
|
The time values are expressed as a percentage of the overall transition time. This
|
|
means that you can create a user-defined transition-type and then use it for transitions
|
|
of different lengths.
|
|
|
|
The values are percentages of the values between the start and end values of the properties
|
|
being animated in the transitions. 0% is the start value and 100% is the end value.
|
|
|
|
The interpolation is one of the values from the InterpolationMethod enum.
|
|
|
|
So the example above accelerates to the destination (as if under gravity) by
|
|
t=50%, then bounces back up to half the initial height by t=75%, slowing down
|
|
(as if against gravity) before falling down again and bouncing to decreasing
|
|
heights each time.
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_UserDefined.#ctor">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_UserDefined.#ctor(System.Collections.Generic.IList{Utilities.BunifuFormDock.Transitions.TransitionElement},System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the list of TransitionElements and the total time
|
|
(in milliseconds) for the transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_UserDefined.setup(System.Collections.Generic.IList{Utilities.BunifuFormDock.Transitions.TransitionElement},System.Int32)">
|
|
<summary>
|
|
Sets up the transitions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_UserDefined.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
Called to find the value for the movement of properties for the time passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.TransitionType_UserDefined.getElementInfo(System.Double,System.Double@,System.Double@,System.Double@,System.Double@,Utilities.BunifuFormDock.Transitions.InterpolationMethod@)">
|
|
<summary>
|
|
Returns the element info for the time-fraction passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuFormDock.Transitions.Utility">
|
|
<summary>
|
|
A class holding static utility functions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Utility.getValue(System.Object,System.String)">
|
|
<summary>
|
|
Returns the value of the property passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Utility.setValue(System.Object,System.String,System.Object)">
|
|
<summary>
|
|
Sets the value of the property passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Utility.interpolate(System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Returns a value between d1 and d2 for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Utility.interpolate(System.Int32,System.Int32,System.Double)">
|
|
<summary>
|
|
Returns a value betweeen i1 and i2 for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Utility.interpolate(System.Single,System.Single,System.Double)">
|
|
<summary>
|
|
Returns a value betweeen f1 and f2 for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Utility.convertLinearToEaseInEaseOut(System.Double)">
|
|
<summary>
|
|
Converts a fraction representing linear time to a fraction representing
|
|
the distance traveled under an ease-in-ease-out transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Utility.convertLinearToAcceleration(System.Double)">
|
|
<summary>
|
|
Converts a fraction representing linear time to a fraction representing
|
|
the distance traveled under a constant acceleration transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Utility.convertLinearToDeceleration(System.Double)">
|
|
<summary>
|
|
Converts a fraction representing linear time to a fraction representing
|
|
the distance traveled under a constant deceleration transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Transitions.Utility.raiseEvent``1(System.EventHandler{``0},System.Object,``0)">
|
|
<summary>
|
|
Fires the event passed in in a thread-safe way.
|
|
</summary><remarks>
|
|
This method loops through the targets of the event and invokes each in turn. If the
|
|
target supports ISychronizeInvoke (such as forms or controls) and is set to run
|
|
on a different thread, then we call BeginInvoke to marshal the event to the target
|
|
thread. If the target does not support this interface (such as most non-form classes)
|
|
or we are on the same thread as the target, then the event is fired on the same
|
|
thread as this is called from.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Utilities.BunifuFormDock.DragControlsEditor.components">
|
|
<summary>
|
|
Required designer variable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.DragControlsEditor.Dispose(System.Boolean)">
|
|
<summary>
|
|
Clean up any resources being used.
|
|
</summary>
|
|
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.DragControlsEditor.InitializeComponent">
|
|
<summary>
|
|
Required method for Designer support - do not modify
|
|
the contents of this method with the code editor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuFormDock.Views.Indicator.components">
|
|
<summary>
|
|
Required designer variable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Views.Indicator.Dispose(System.Boolean)">
|
|
<summary>
|
|
Clean up any resources being used.
|
|
</summary>
|
|
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuFormDock.Views.Indicator.InitializeComponent">
|
|
<summary>
|
|
Required method for Designer support - do not modify
|
|
the contents of this method with the code editor.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|