IConsolePaneCaption Property

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.

string Caption { get; set; }

Property Caption As String
	Get
	Set