IConsolePaneHeader Interface

The interface implemented by the IConsolePane header on IConsoleTemplate pages accessible via the pane's PaneHeader property.

Namespace: NetQuarry
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)

Syntax

public interface IConsolePaneHeader

Public Interface IConsolePaneHeader

The IConsolePaneHeader type exposes the following members.

Properties

	Name	Description
	Caption	Gets/sets the pane header caption. Note that this is really just a passthrough call to IConsolePane.Caption. See IConsolePane.Caption for more information regarding the complexities of console pane caption handling.
	CaptionControl	Gets the header's caption control.
	ContentRow	Gets the row that contains the header content itself including Toggler, caption, and buttons.
	HeaderControl	Gets the header's control.

Methods

	Name	Description
	AddCommand	Add a command to the header control.
	AddItem(WebControl)	Add a button to the header. Typically this is an icon-type button using a ActiveImageButton control. By default buttons are positioned in the header in the order in which they are added, but prior to any standard platform buttons. You can use AddItem(WebControl, Int32) to add buttons in a specific order, including after or between platform buttons, but this is not generally recommended.
	AddItem(WebControl, Int32)	Add a button to the header. Typically this is an icon-type button using a ActiveImageButton control. This method is provided primarily for internal use and application-specific buttons should normally be added via AddItem(WebControl) which assigns an order of zero and results in placement before all platform buttons (which are assigned positive order numbers). At this time the following order numbers are used for standard platform buttons: 10000 - The pane Close (X) button or main pane's pane selection dialog. 1000 - Pane element selection dialog. 100 - Starting range for developer buttons. Buttons are positioned by increasing order number. Order numbers are not required to be contiguous and may be negative. Buttons having the same order number are positioned in the order added.