IConsolePane Properties

Returns the IAppContext object.

Gets/sets the ConsolePaneAttrs for this pane. These are initially extracted from the ConsolePaneAttrs property on the element's PageElementInfo and then maintained internally to the pane. Note that since these are maintained on the object, changes made to the PageElementInfo property after the pane has been instantiated will have no effect.

Gets/sets the pane IConsolePaneHeader caption, also available from IConsolePaneHeader.Caption which is really just a passthrough call to this property. Getting the caption involves a sequence of events outlined here. However, once the caption is set programmatically via this property that sequence is short-circuited and the programmatically set caption is used without resolving any field references or embedded functions and is not escaped for HTML.

Note that there are some significant complexities to console pane caption handling:

• The pane's base caption is obtained from its renderer which may include paging or filtering information depending on the renderer and pane options.
• The caption is escaped for HTML unless the pane's HtmlCaption attribute is set.
• The caption is resolved for embedded functions and field references using the pane's IMapper.
• If the pane has no IMapper the main pane will be used to resolve field references.

At PreRender-time the caption is rendered inside the LinkList HyperLink which may, or may not be navigable.

Gets the IConsoleTemplate containing this pane.

Gets/Sets the Description control for the pane.

Gets the page PageElementInfo for this pane. This property should rarely be set. When there is need to set the property the existing PageElementInfo should be cloned via Clone(IAppContext) and used.

Gets/sets the expanded state of the pane. Note that this property is not meaningful if read, and has no effect if set, until after the ConsolePaneBeforeLayout event.

Gets the pane header control. As of v3.5.3, the header control implements the IConsolePaneHeader interface which is exposed via PaneHeader.

Gets whether or not this pane is the ActivePane for the IConsoleTemplate. The ActivePane is the pane driving the current action and controlling the toolbar. Unless PaneNavigation is in play, the ActivePane is always the MainPane. However, when PaneNavigation is in play, the ActivePane is often not the same pane as the MainPane. Use IsMainPane to determine whether or not this is the MainPane.

Gets whether or not this pane is in a fixed position (top or bottom).

Gets/sets whether or not this pane is in an error state (typically due to an error in the underlying query).

Gets whether or not this pane is the MainPane for the IConsoleTemplate. Note that when PaneNavigation is in play the ActivePane is often more significant than the MainPane. Use IsActivePane to determine whether or not this is the ActivePane.

Identifies whether or not this pane is acting as the ToolbarController. This property is intended to be read. The set operation is entirely for internal use.

Gets the "Add" link, if any (may be null).

Gets the "List" link, if any (may be null). The Caption is rendered into this element at PreRender-time. The link resides in the pane's header.

Gets the "New" link, if any (may be null).

Gets the "Save" LinkButton, if any (may be null).

Gets the pane's "View" link, if any (may be null). The View link is only shown when the ShowPaneLink UI feature is set. The link resides in the pane's header.

Gets the primary IMapper associated with the renderer for this pane. Note that not all renderers have a primary mapper so this may return null. This property should be used instead of MapperObject which returns the same result but untyped and is provided only for backward compatibility.

Gets the primary IMapper associated with the renderer for this pane. Note that not all renderers have a primary mapper so this may return null. This property is provided only for backward compatibility, you should use Mapper which returns the same result, but properly typed.

Gets the pane's name from the Name.

Gets the outer control of the pane control hierarchy.

Gets the IConsolePaneHeader for this pane. Note that HeaderControl references the same header object, but as a WebControl.

Gets/sets the pane visibility PageElementVisibility. These are initially extracted from the PaneVisibility property on the element's PageElementInfo and then maintained internally to the pane. Note that since these are maintained on the object, changes made to the PageElementInfo property after the pane has been instantiated will have no effect.

Gets the renderer for this pane. The renderer is expected to be derived from the EAPControlBase class and implement the IRenderer interface.

Gets IToggler interface for the object used to toggle the pane open/closed, if any (may be null). This access is preferred over the older TogglerControl property.

Gets the object used to toggle the pane open/closed, if any (may be null). If present, the toggler is expected to be an instance of the Toggler or TogglerB class each of which implement the IToggler interface accessible via Toggler.