DocumentWindow Class
Represents a document window.
public class DocumentWindow : TabbedMdiWindow, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IDockObject, IImageListProvider- Inheritance:
- object MarshalByRefObject Component Control ScrollableControl ContainerControl UIContainerControl TabbedMdiWindow object
- Implements:
- IUIControl IUIElement ILogicalTreeNode IDpiAwareElement IDisposable IDockObject IImageListProvider
Constructors
DocumentWindow()
Initializes an instance of the class.
public DocumentWindow()Remarks
For internal use only. Please use the other constructors.
DocumentWindow(DockManager, string, string, Image?, Control?)
Initializes an instance of the class.
public DocumentWindow(DockManager dockManager, string key, string text, Image? image, Control? childControl = null)| Parameter | Type | Description |
|---|---|---|
| dockManager | DockManager | The DockManager that is managing the dock object. |
| key | string | A string-based key that identifies an object within its parent collection. |
| text | string | The text that is displayed in tabs for the document window. |
| image | Image | The |
| childControl | Control | The child Control to fill the document window. This value may be |
DocumentWindow(DockManager, string, string, int, Control?)
Initializes an instance of the class.
public DocumentWindow(DockManager dockManager, string key, string text, int imageIndex = -1, Control? childControl = null)| Parameter | Type | Description |
|---|---|---|
| dockManager | DockManager | The DockManager that is managing the dock object. |
| key | string | A string-based key that identifies an object within its parent collection. |
| text | string | The text that is displayed in tabs for the document window. |
| imageIndex | int | The index of an |
| childControl | Control | The child Control to fill the document window. This value may be |
Properties
CanFloat
Indicates whether the document window may be contained in a floating window.
public DefaultableBoolean CanFloat { get; set; }Property Value
Remarks
If set to Default, the resolved value will use the global DockManager setting.
DefaultFloatingLocation
The default value for FloatingLocation.
DefaultFloatingSize
The default value for FloatingSize.
DockManager
The DockManager that is managing the dock object.
[Browsable(false)]
public override DockManager? DockManager { get; set; }Property Value
DockObjectType
A DockObjectType specifying the type of dock object.
[Browsable(false)]
public override DockObjectType DockObjectType { get; }Property Value
FileName
The file name represented by this document window.
public string? FileName { get; set; }Property Value
Remarks
This property's value is displayed on the Next Window Navigation Form.
FileType
The file type represented by this document window.
public string? FileType { get; set; }Property Value
Remarks
This property's value is displayed on the Next Window Navigation Form.
FloatingLocation
The location of the document window when it is in a floating state.
public Point FloatingLocation { get; set; }Property Value
Remarks
Setting this property at run-time will move the document window if it is floating.
FloatingSize
The size of the document window when it is in a floating state.
public Size FloatingSize { get; set; }Property Value
Remarks
Setting this property at run-time will resize the document window if it is floating.
Modified
Indicates whether the document window's data has been modified.
public bool Modified { get; set; }Property Value
- bool:
trueif the document window's data has been modified; otherwise,false.
Remarks
If this property is set to true then an asterisk (*) character will appear next to its name in tabs.
State
The DocumentWindowState of the document window.
[Browsable(false)]
public DocumentWindowState State { get; set; }Property Value
TabbedMdiContainer
The TabbedMdiContainer that contains the dock object.
[Browsable(false)]
public override TabbedMdiContainer? TabbedMdiContainer { get; }Property Value
Methods
Activate(bool)
Activates the window, ensures that it is visible, and optionally sets focus.
public override void Activate(bool focus)| Parameter | Type | Description |
|---|---|---|
| focus | bool | Whether to set focus to the window. |
Close(TabbedMdiWindowCloseReason)
Closes the window.
public override void Close(TabbedMdiWindowCloseReason reason)| Parameter | Type | Description |
|---|---|---|
| reason | TabbedMdiWindowCloseReason | A TabbedMdiWindowCloseReason that specifies why the window was closed. |
Dispose(bool)
Releases the unmanaged resources used by the Control and its child controls and optionally releases the managed resources.
protected override void Dispose(bool disposing)| Parameter | Type | Description |
|---|---|---|
| disposing | bool |
|
IsMenuItemChecked(TabbedMdiWindowContextMenuItemType)
Returns whether the specified type of menu item should be checked for the window.
public override bool IsMenuItemChecked(TabbedMdiWindowContextMenuItemType menuItemType)| Parameter | Type | Description |
|---|---|---|
| menuItemType | TabbedMdiWindowContextMenuItemType | A TabbedMdiWindowContextMenuItemType specifying the type of menu item to examine. |
Returns
- bool:
trueif the menu item type should be checked; otherwise,false.
IsMenuItemEnabled(TabbedMdiWindowContextMenuItemType)
Returns whether the specified type of menu item should be enabled for the window.
public override bool IsMenuItemEnabled(TabbedMdiWindowContextMenuItemType menuItemType)| Parameter | Type | Description |
|---|---|---|
| menuItemType | TabbedMdiWindowContextMenuItemType | A TabbedMdiWindowContextMenuItemType specifying the type of menu item to examine. |
Returns
- bool:
trueif the menu item type should be enabled; otherwise,false.
IsMenuItemVisible(TabbedMdiWindowContextMenuItemType)
Returns whether the specified type of menu item should be visible for the window.
public override bool IsMenuItemVisible(TabbedMdiWindowContextMenuItemType menuItemType)| Parameter | Type | Description |
|---|---|---|
| menuItemType | TabbedMdiWindowContextMenuItemType | A TabbedMdiWindowContextMenuItemType specifying the type of menu item to examine. |
Returns
- bool:
trueif the menu item type should be visible; otherwise,false.
ResetFloatingLocation()
Resets the FloatingLocation property to its default value.
public virtual void ResetFloatingLocation()ResetFloatingSize()
Resets the FloatingSize property to its default value.
public virtual void ResetFloatingSize()ShouldSerializeFloatingLocation()
Indicates whether the FloatingLocation property should be persisted.
public virtual bool ShouldSerializeFloatingLocation()Returns
- bool:
trueif the property value has changed from its default; otherwise,false.
ShouldSerializeFloatingSize()
Indicates whether the FloatingSize property should be persisted.
public virtual bool ShouldSerializeFloatingSize()Returns
- bool:
trueif the property value has changed from its default; otherwise,false.
Undock()
Undocks the DocumentWindow.
public void Undock()UpdateUI()
Updates the user interface that is related to the window.
protected override void UpdateUI()Inherited Members
- TabbedMdiWindow.Activate()
- TabbedMdiWindow.ResetBackgroundFill()
- TabbedMdiWindow.ShouldSerializeBackgroundFill()
- TabbedMdiWindow.ResetBorder()
- TabbedMdiWindow.ShouldSerializeBorder()
- TabbedMdiWindow.Close()
- TabbedMdiWindow.GetImage()
- TabbedMdiWindow.MoveToNewHorizontalTabbedMdiContainer()
- TabbedMdiWindow.MoveToNewVerticalTabbedMdiContainer()
- TabbedMdiWindow.MoveToNextTabbedMdiContainer()
- TabbedMdiWindow.MoveToPositionInTabbedMdiContainer(int)
- TabbedMdiWindow.MoveToPreviousTabbedMdiContainer()
- TabbedMdiWindow.OnActivated(TabbedMdiWindowEventArgs)
- TabbedMdiWindow.OnActivating(TabbedMdiWindowEventArgs)
- TabbedMdiWindow.OnClosing(TabbedMdiWindowClosingEventArgs)
- TabbedMdiWindow.OnClosed(TabbedMdiWindowEventArgs)
- TabbedMdiWindow.OnEnter(EventArgs)
- TabbedMdiWindow.OnInitializing(TabbedMdiWindowEventArgs)
- TabbedMdiWindow.OnRender(PaintEventArgs)
- TabbedMdiWindow.OnStateChanged(TabbedMdiWindowEventArgs)
- TabbedMdiWindow.ResetStandardMdiBounds()
- TabbedMdiWindow.ShouldSerializeStandardMdiBounds()
- TabbedMdiWindow.WndProc(ref Message)
- TabbedMdiWindow.Active
- TabbedMdiWindow.BackgroundFill
- TabbedMdiWindow.Border
- TabbedMdiWindow.CanClose
- TabbedMdiWindow.ContextImage
- TabbedMdiWindow.CreationMethod
- TabbedMdiWindow.DefaultSize
- TabbedMdiWindow.DisplayRectangle
- TabbedMdiWindow.Image
- TabbedMdiWindow.ImageIndex
- TabbedMdiWindow.IsInitialized
- TabbedMdiWindow.Key
- TabbedMdiWindow.StandardMdiBounds
- TabbedMdiWindow.Text
- TabbedMdiWindow.TitleBarText
- TabbedMdiWindow.ToolTipText
- TabbedMdiWindow.UseExtendedDoubleBuffering
- TabbedMdiWindow.Visible
- TabbedMdiWindow.Activated
- TabbedMdiWindow.Activating
- TabbedMdiWindow.Closed
- TabbedMdiWindow.Closing
- TabbedMdiWindow.Initializing
- TabbedMdiWindow.StateChanged
- UIContainerControl.AddPendingGraphicsInversion(Rectangle)
- UIContainerControl.AddPendingScrollOperation(Rectangle, Orientation, int)
- UIContainerControl.AddPendingScrollOperation(Rectangle, int, int)
- UIContainerControl.AddToInvalidatedRegion()
- UIContainerControl.AddToInvalidatedRegion(Rectangle)
- UIContainerControl.Arrange(Rectangle)
- UIContainerControl.ArrangeOverride(Size)
- UIContainerControl.ContainsLocation(Point)
- UIContainerControl.CreateChildren()
- UIContainerControl.DpiScaleChanged(SizeF)
- UIContainerControl.GetCursor(Point)
- UIContainerControl.HitTest(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, bool>)
- UIContainerControl.HitTestRecursive(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, bool>)
- UIContainerControl.Invalidate(InvalidationLevels, InvalidationTypes)
- UIContainerControl.InvalidateArrange()
- UIContainerControl.InvalidateMeasure()
- UIContainerControl.Measure(Graphics, Size)
- UIContainerControl.MeasureOverride(Graphics, Size)
- UIContainerControl.OnClick(EventArgs)
- UIContainerControl.OnDoubleClick(EventArgs)
- UIContainerControl.OnDpiChangedAfterParent(EventArgs)
- UIContainerControl.OnHandleCreated(EventArgs)
- UIContainerControl.OnLayout(LayoutEventArgs)
- UIContainerControl.OnLocationChanged(EventArgs)
- UIContainerControl.OnMouseCaptureChanged(EventArgs)
- UIContainerControl.OnMouseDown(MouseEventArgs)
- UIContainerControl.OnMouseEnter(EventArgs)
- UIContainerControl.OnMouseHover(EventArgs)
- UIContainerControl.OnMouseLeave(EventArgs)
- UIContainerControl.OnMouseMove(MouseEventArgs)
- UIContainerControl.OnMouseUp(MouseEventArgs)
- UIContainerControl.OnMouseWheel(MouseEventArgs)
- UIContainerControl.OnPaint(PaintEventArgs)
- UIContainerControl.OnPaintBackground(PaintEventArgs)
- UIContainerControl.OnParentChanged()
- UIContainerControl.OnParentChanged(EventArgs)
- UIContainerControl.OnRenderChildElements(PaintEventArgs)
- UIContainerControl.OnResize(EventArgs)
- UIContainerControl.OnRightToLeftChanged(EventArgs)
- UIContainerControl.OnVisibleChanged(EventArgs)
- UIContainerControl.Render(PaintEventArgs)
- UIContainerControl.ResetDoubleBufferCanvas(bool)
- UIContainerControl.ResumePainting()
- UIContainerControl.SuspendPainting()
- UIContainerControl.TransformToAncestor(IUIElement)
- UIContainerControl.TransformToDescendant(IUIElement)
- UIContainerControl.UpdateCursor()
- UIContainerControl.UpdateCursor(Point)
- UIContainerControl.UpdateLayout()
- UIContainerControl.ActualHeight
- UIContainerControl.ActualWidth
- UIContainerControl.BackColor
- UIContainerControl.BackgroundImage
- UIContainerControl.CaptureMouseWhenPressed
- UIContainerControl.ClipBounds
- UIContainerControl.DesiredSize
- UIContainerControl.DpiScaleFactor
- UIContainerControl.Font
- UIContainerControl.ForeColor
- UIContainerControl.IsArrangeValid
- UIContainerControl.IsMeasureValid
- UIContainerControl.IsPaintValid
- UIContainerControl.IsRightToLeft
- UIContainerControl.LastMouseUpButton
- UIContainerControl.PaintingSuspended
- UIContainerControl.UseControlGraphicsForMeasure
- MarshalByRefObject.GetLifetimeService()
- MarshalByRefObject.InitializeLifetimeService()
- MarshalByRefObject.MemberwiseClone(bool)
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()