WebZone.HasHeader Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets a value indicating whether a zone has a header area.
protected:
virtual property bool HasHeader { bool get(); };
protected virtual bool HasHeader { get; }
member this.HasHeader : bool
Protected Overridable ReadOnly Property HasHeader As Boolean
Property Value
true
if the zone has a header area; otherwise, false
. The default value is true
.
Remarks
The HasHeader property is primarily used by control developers who are creating custom zones. It exists as a flag so that the Web Parts control set renders a header only when appropriate for a zone. For example, the HasHeader property overrides this property and returns false
unless the page is in one of the modes that allow personalization. In this case, a header is not rendered for a WebPartZone control in browse mode, while in most other modes a header is rendered. For more information on display modes and enabling users to switch among them, see Walkthrough: Changing Display Modes on a Web Parts Page.
Tool zones (zones that derive indirectly from the WebZone class by means of the ToolZone class, such as EditorZone and CatalogZone) must have headers that appear only when the page is in the appropriate display mode. Because the HasHeader property is true
by default, they do not need to override the property.
Notes to Inheritors
If you are creating a custom tool zone that derives from ToolZone, you can override the RenderHeader(HtmlTextWriter) method and provide rendering for your zone's header.