Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

DocumentWindow Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.Docking
Assembly:
ActiproSoftware.Docking.WinForms.dll

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 a new instance of the DocumentWindow class.

public DocumentWindow()

Remarks

For internal use only. Please use the other constructors.

DocumentWindow(DockManager, string, string, Image, Control)

Initializes a new instance of the DocumentWindow class.

public DocumentWindow(DockManager dockManager, string key, string text, Image image, Control childControl)
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 Image displayed for the document window.
childControl Control

The child Control to fill the document window. This value may be null.

DocumentWindow(DockManager, string, string, int, Control)

Initializes a new instance of the DocumentWindow class.

public DocumentWindow(DockManager dockManager, string key, string text, int imageIndex, Control childControl)
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 Image within an ImageList, that is displayed for the document window.
childControl Control

The child Control to fill the document window. This value may be null.

Properties

CanFloat

Gets or sets whether the document window may be contained in a floating window.

public DefaultableBoolean CanFloat { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean that indicates whether the document window may be contained in a floating window.

Remarks

If set to DefaultableBoolean.Default, the resolved value will use the global DockManager setting.

DefaultFloatingLocation

Gets or sets the default value for FloatingLocation.

public static Point DefaultFloatingLocation { get; set; }

Property Value

Point

DefaultFloatingSize

Gets or sets the default value for FloatingSize.

public static Size DefaultFloatingSize { get; set; }

Property Value

Size

DockManager

Gets or sets the DockManager that is managing the dock object.

[Browsable(false)]
public override DockManager DockManager { get; set; }

Property Value

DockManager:

The DockManager that is managing the dock object.

DockObjectType

Gets a DockObjectType specifying the type of dock object.

[Browsable(false)]
public override DockObjectType DockObjectType { get; }

Property Value

DockObjectType:

A DockObjectType specifying the type of dock object.

FileName

Gets or sets the file name represented by this document window.

public string FileName { get; set; }

Property Value

string:

The file name represented by this document window.

Remarks

This property's value is displayed on the Next Window Navigation Form.

FileType

Gets or sets the file type represented by this document window.

public string FileType { get; set; }

Property Value

string:

The file type represented by this document window.

Remarks

This property's value is displayed on the Next Window Navigation Form.

FloatingLocation

Gets or sets the location of the document window when it is in a floating state.

public Point FloatingLocation { get; set; }

Property Value

Point:

The location of the document window when it is in a floating state.

Remarks

Setting this property at run-time will move the document window if it is floating.

FloatingSize

Gets or sets the size of the document window when it is in a floating state.

public Size FloatingSize { get; set; }

Property Value

Size:

The size of the document window when it is in a floating state.

Remarks

Setting this property at run-time will resize the document window if it is floating.

Modified

Gets or sets whether the document window's data has been modified.

public bool Modified { get; set; }

Property Value

bool:

true if 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

Gets or sets the DocumentWindowState of the document window.

[Browsable(false)]
public DocumentWindowState State { get; set; }

Property Value

DocumentWindowState:

The DocumentWindowState of the document window.

TabbedMdiContainer

Gets the TabbedMdiContainer that contains the dock object.

[Browsable(false)]
public override TabbedMdiContainer TabbedMdiContainer { get; }

Property Value

TabbedMdiContainer:

The TabbedMdiContainer that contains the dock object.

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 document window.

public override void Close(TabbedMdiWindowCloseReason reason)
Parameter Type Description
reason TabbedMdiWindowCloseReason

A TabbedMdiWindowCloseReason that specifies why the window was closed.

Dispose(bool)

Disposes any resources used by the object.

protected override void Dispose(bool disposing)
Parameter Type Description
disposing bool

Whether the object is being disposed.

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:

true if 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:

true if 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:

true if 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:

true if 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:

true if 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