Interface IAuiPaneInfo

Namespace: Alternet.UI

Assembly: Alternet.UI.dll

Specifies all the parameters for a pane managed by AuiManager.

public interface IAuiPaneInfo : IBaseControlItem, IBaseObject, IDisposable

Remarks

These parameters specify where the pane is on the screen, whether it is docked or floating, or hidden. In addition, these parameters specify the pane's docked position, floating position, preferred size, minimum size, caption text among many other parameters.

Properties

Handle: Returns handle of the pane info object.

Owner: Gets owner.

Methods

BestSizeDip(double, double): Sets the ideal size for the pane.

BestSizePixel(int, int): Sets the ideal size for the pane.

Bottom(): Sets the pane dock position to the bottom side of the frame.

BottomDockable(bool): Indicates whether a pane can be docked at the bottom of the frame.

Caption(string): Sets the caption of the pane.

CaptionVisible(bool): Indicates that a pane caption should be visible.

Center(): Sets the pane dock position to the center of the frame.

CenterPane(): Specifies that the pane should adopt the default center pane settings.

CloseButton(bool): Indicates that a close button should be drawn for the pane.

DefaultPane(): Specifies that the pane should adopt the default pane settings.

Direction(AuiManagerDock): Determines the direction of the docked pane.

Dock(): Indicates that a pane should be docked. It is the opposite of Float().

DockFixed(bool): Causes the containing dock to have no resize sash.

Dockable(bool): Specifies whether a frame can be docked or not.

Fixed(): Forces a pane to be fixed size so that it cannot be resized.

Float(): Indicates that a pane should be floated. It is the opposite of Dock().

Floatable(bool): Sets whether the user will be able to undock a pane and turn it into a floating window.

FloatingPositionPixel(int, int): Sets the position of the floating pane.

FloatingSizePixel(int, int): Sets the size of the floating pane.

GetBestSizePixel(): Gets size that the layout engine will prefer.

GetMaxSizePixel(): Gets maximum size the pane window can tolerate.

GetMinSizePixel(): Gets minimum size the pane window can tolerate.

Gripper(bool): Indicates that a gripper should be drawn for the pane.

GripperTop(bool): Indicates that a gripper should be drawn at the top of the pane.

HasBorder(): Returns true if the pane displays a border.

HasCaption(): Returns true if the pane displays a caption.

HasCloseButton(): Returns true if the pane displays a button to close the pane.

HasFlag(int): Returns true if the property specified by flag is active for the pane.

HasGripper(): Returns true if the pane displays a gripper.

HasGripperTop(): Returns true if the pane displays a gripper at the top.

HasMaximizeButton(): Returns true if the pane displays a button to maximize the pane.

HasMinimizeButton(): Returns true if the pane displays a button to minimize the pane.

HasPinButton(): Returns true if the pane displays a button to float the pane.

Hide(): Indicates that a pane should be hidden.

Image(ImageSet?): Sets the icon of the pane.

IsBottomDockable(): Returns true if the pane can be docked at the bottom of the managed frame.

IsDockable(): Returns true if the pane can be docked at any side.

IsDocked(): Returns true if the pane is currently docked.

IsFixed(): Returns true if the pane cannot be resized.

IsFloatable(): Returns true if the pane can be undocked and displayed as a floating window.

IsFloating(): Returns true if the pane is floating.

IsLeftDockable(): Returns true if the pane can be docked on the left of the managed frame.

IsMaximized(): Returns true if pane is maximized.

IsMovable(): Returns true if the docked frame can be undocked or moved to another dock position.

IsOk(): Returns true if the IAuiPaneInfo structure is valid.

IsResizable(): Returns true if the pane can be resized.

IsRightDockable(): Returns true if the pane can be docked on the right of the managed frame.

IsShown(): Returns true if the pane is currently shown.

IsToolbar(): Returns true if the pane contains a toolbar.

IsTopDockable(): Returns true if the pane can be docked at the top of the managed frame.

Layer(int): Determines the layer of the docked pane.

Left(): Sets the pane dock position to the left of the frame.

LeftDockable(bool): Indicates whether a pane can be docked on the left of the frame.

MaxSizeDip(SizeD): Sets the maximum size of the pane.

MaxSizePixel(int, int): Sets the maximum size of the pane.

Maximize(): Maximizes pane size.

MaximizeButton(bool): Indicates that a maximize button should be drawn for the pane.

MinSizeDip(double, double): Sets the minimum size of the pane.

MinSizePixel(int, int): Sets the minimum size of the pane.

MinimizeButton(bool): Indicates that a minimize button should be drawn for the pane.

Movable(bool): Indicates whether a frame can be moved.

Name(string): Sets the name of the pane so it can be referenced in lookup functions.

PaneBorder(bool): Indicates that a border should be drawn for the pane.

PinButton(bool): Indicates that a pin button should be drawn for the pane.

Position(int): Sets the position of the docked pane.

Resizable(bool): Determines whether pane can be resized.

Restore(): Restores pane position and size.

Right(): Sets the pane dock position to the right of the frame.

RightDockable(bool): Indicates whether a pane can be docked on the right of the frame.

Row(int): Sets the row of the docked pane.

SafeSet(IAuiPaneInfo): Writes the safe parts of a IAuiPaneInfo object source into "this".

SetFlag(int, bool): Turns the property given by flag on or off with the option_state parameter.

Show(bool): Indicates that a pane should be shown.

ToolbarPane(): Specifies that the pane should adopt the default toolbar pane settings.

Top(): Sets the pane dock position to the top of the frame.

TopDockable(bool): Indicates whether a pane can be docked at the top of the frame.

Window(Control): Assigns the control reference that the IAuiPaneInfo should use.

Table of Contents

Interface IAuiPaneInfo

Remarks

Properties

Methods