ESRI.ArcGIS.ADF.Web.UI.WebControls
HeaderFormatString Property
See Also  Send Feedback
ESRI.ArcGIS.ADF.Web.UI.WebControls Namespace > MapTips Class : HeaderFormatString Property




The format string for the map tips header. Required property.

Syntax

Visual Basic (Declaration) 
<DefaultValueAttribute()>
<NotifyParentPropertyAttribute(True)>
<ResCategoryAttribute("MapTips")>
<ResDescriptionAttribute("This property is no longer used.")>
<EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="ESRI.ArcGIS.ADF.Web.UI.WebControls.Design.MapTipsExpressionEditor, ESRI.ArcGIS.ADF.Web.UI.WebControls, Version=10.1.0.0, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86")>
<PersistenceModeAttribute(PersistenceMode.Attribute)>
<BrowsableAttribute(False)>
<ObsoleteAttribute("Use the LayerFormat property")>
Public Property HeaderFormatString As String
Visual Basic (Usage)Copy Code
Dim instance As MapTips
Dim value As String
 
instance.HeaderFormatString = value
 
value = instance.HeaderFormatString
C# 
[DefaultValueAttribute()]
[NotifyParentPropertyAttribute(true)]
[ResCategoryAttribute("MapTips")]
[ResDescriptionAttribute("This property is no longer used.")]
[EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="ESRI.ArcGIS.ADF.Web.UI.WebControls.Design.MapTipsExpressionEditor, ESRI.ArcGIS.ADF.Web.UI.WebControls, Version=10.1.0.0, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86")]
[PersistenceModeAttribute(PersistenceMode.Attribute)]
[BrowsableAttribute(false)]
[ObsoleteAttribute("Use the LayerFormat property")]
public string HeaderFormatString {get; set;}

Property Value

Format string for maptip header.

Remarks

When the user hovers over the maptip icon, a small popup window displays the information set in this property (along with the string "Click icon for more information").

This property is required. If not set, a runtime error will occur when the page attempts to display maptips.

If the user clicks the maptip icon, the maptip remains on the page until closed, and additional information is displayed as specified in the BodyFormatString property. The maptip may be moved around the page once it is clicked on.

The header content may include both attribute fields of the feature at the maptip location, as well as any other content added by the developer, including hyperlinks. Note that hyperlinks cannot be clicked on unless the user clicks the maptip icon to pin the maptip to the page; it may be preferable to add the hyperlink to the body via the BodyFormatString.

For more information on setting maptip content, see the MapTips control discussion in the Developer Help.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2011 All Rights Reserved.